hidapi-0.1.8: Haskell bindings to HIDAPI
Safe HaskellNone
LanguageHaskell2010

System.HIDAPI

Documentation

init :: IO () Source #

exit :: IO () Source #

withHIDAPI :: IO a -> IO a Source #

enumerate :: Maybe VendorID -> Maybe ProductID -> IO [DeviceInfo] Source #

enumerateAll :: IO [DeviceInfo] Source #

open :: VendorID -> ProductID -> Maybe SerialNumber -> IO Device Source #

openPath :: DevicePath -> IO Device Source #

openDeviceInfo :: DeviceInfo -> IO Device Source #

close :: Device -> IO () Source #

read :: Device -> Int -> IO ByteString Source #

readTimeout :: Device -> Int -> Int -> IO ByteString Source #

setBlocking :: Device -> Bool -> IO () Source #

write :: Device -> ByteString -> IO Int Source #

getFeatureReport :: Device -> ReportID -> ReportLength -> IO FeatureReport Source #

sendFeatureReport :: Device -> ReportID -> ByteString -> IO Int Source #

getSerialNumberString :: Device -> IO SerialNumber Source #

error :: Device -> IO (Maybe String) Source #

data HIDAPIException Source #

Constructors

HIDAPIException String String 

Instances

Instances details
NFData HIDAPIException Source # 
Instance details

Defined in System.HIDAPI

Methods

rnf :: HIDAPIException -> () #

Data HIDAPIException Source # 
Instance details

Defined in System.HIDAPI

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> HIDAPIException -> c HIDAPIException #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c HIDAPIException #

toConstr :: HIDAPIException -> Constr #

dataTypeOf :: HIDAPIException -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c HIDAPIException) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c HIDAPIException) #

gmapT :: (forall b. Data b => b -> b) -> HIDAPIException -> HIDAPIException #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> HIDAPIException -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> HIDAPIException -> r #

gmapQ :: (forall d. Data d => d -> u) -> HIDAPIException -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> HIDAPIException -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> HIDAPIException -> m HIDAPIException #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> HIDAPIException -> m HIDAPIException #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> HIDAPIException -> m HIDAPIException #

Exception HIDAPIException Source # 
Instance details

Defined in System.HIDAPI

Methods

toException :: HIDAPIException -> SomeException #

fromException :: SomeException -> Maybe HIDAPIException #

displayException :: HIDAPIException -> String #

backtraceDesired :: HIDAPIException -> Bool #

Generic HIDAPIException Source # 
Instance details

Defined in System.HIDAPI

Associated Types

type Rep HIDAPIException 
Instance details

Defined in System.HIDAPI

type Rep HIDAPIException = D1 ('MetaData "HIDAPIException" "System.HIDAPI" "hidapi-0.1.8-1tdTtiqXnZkGL6iYkeNPqV" 'False) (C1 ('MetaCons "HIDAPIException" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))

Methods

from :: HIDAPIException -> Rep HIDAPIException x #

to :: Rep HIDAPIException x -> HIDAPIException #

Show HIDAPIException Source # 
Instance details

Defined in System.HIDAPI

Methods

showsPrec :: Int -> HIDAPIException -> ShowS #

show :: HIDAPIException -> String #

showList :: [HIDAPIException] -> ShowS #

type Rep HIDAPIException Source # 
Instance details

Defined in System.HIDAPI

type Rep HIDAPIException = D1 ('MetaData "HIDAPIException" "System.HIDAPI" "hidapi-0.1.8-1tdTtiqXnZkGL6iYkeNPqV" 'False) (C1 ('MetaCons "HIDAPIException" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))

data Device Source #

data DeviceInfo Source #

Constructors

DeviceInfo 

Fields

Instances

Instances details
NFData DeviceInfo Source # 
Instance details

Defined in System.HIDAPI

Methods

rnf :: DeviceInfo -> () #

Generic DeviceInfo Source # 
Instance details

Defined in System.HIDAPI

Associated Types

type Rep DeviceInfo 
Instance details

Defined in System.HIDAPI

type Rep DeviceInfo = D1 ('MetaData "DeviceInfo" "System.HIDAPI" "hidapi-0.1.8-1tdTtiqXnZkGL6iYkeNPqV" 'False) (C1 ('MetaCons "DeviceInfo" 'PrefixI 'True) (((S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DevicePath) :*: S1 ('MetaSel ('Just "vendorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VendorID)) :*: (S1 ('MetaSel ('Just "productId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProductID) :*: (S1 ('MetaSel ('Just "serialNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SerialNumber)) :*: S1 ('MetaSel ('Just "releaseNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ReleaseNumber)))) :*: ((S1 ('MetaSel ('Just "manufacturerString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String)) :*: S1 ('MetaSel ('Just "productString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String))) :*: (S1 ('MetaSel ('Just "usagePage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16) :*: (S1 ('MetaSel ('Just "usage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16) :*: S1 ('MetaSel ('Just "interfaceNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InterfaceNumber))))))

Methods

from :: DeviceInfo -> Rep DeviceInfo x #

to :: Rep DeviceInfo x -> DeviceInfo #

Show DeviceInfo Source # 
Instance details

Defined in System.HIDAPI

Methods

showsPrec :: Int -> DeviceInfo -> ShowS #

show :: DeviceInfo -> String #

showList :: [DeviceInfo] -> ShowS #

type Rep DeviceInfo Source # 
Instance details

Defined in System.HIDAPI

type Rep DeviceInfo = D1 ('MetaData "DeviceInfo" "System.HIDAPI" "hidapi-0.1.8-1tdTtiqXnZkGL6iYkeNPqV" 'False) (C1 ('MetaCons "DeviceInfo" 'PrefixI 'True) (((S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DevicePath) :*: S1 ('MetaSel ('Just "vendorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VendorID)) :*: (S1 ('MetaSel ('Just "productId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProductID) :*: (S1 ('MetaSel ('Just "serialNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SerialNumber)) :*: S1 ('MetaSel ('Just "releaseNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ReleaseNumber)))) :*: ((S1 ('MetaSel ('Just "manufacturerString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String)) :*: S1 ('MetaSel ('Just "productString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String))) :*: (S1 ('MetaSel ('Just "usagePage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16) :*: (S1 ('MetaSel ('Just "usage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16) :*: S1 ('MetaSel ('Just "interfaceNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InterfaceNumber))))))

type DevicePath = String Source #

type VendorID = Word16 Source #

type ProductID = Word16 Source #

type ReleaseNumber = Word16 Source #

type SerialNumber = String Source #

type InterfaceNumber = Int Source #