Copyright	(c) James Sully 2020-2021
License	BSD 3-Clause
Maintainer	sullyj3@gmail.com
Stability	experimental
Portability	untested
Safe Haskell	None
Language	Haskell2010

Buttplug.Core.Device

Description

Types for representing sex toys, as well as ways of actuating them.

Synopsis

data MessageAttributes = MessageAttributes {
- attrFeatureCount :: Maybe Word
- attrStepCount :: Maybe [Word]
}
data Device = Device {
- deviceName :: Text
- deviceIndex :: Word
- deviceMessages :: Map DeviceMessageType MessageAttributes
}
data DeviceMessageType
- = DevRawWriteCmd
- | DevRawReadCmd
- | DevRawSubscribeCmd
- | DevRawUnsubscribeCmd
- | DevStopDeviceCmd
- | DevVibrateCmd
- | DevLinearCmd
- | DevRotateCmd

Documentation

data MessageAttributes Source #

For a particular actuation feature (Vibration, Rotation, or Linear), represents how many of that feature the device has, and the available resolution of control of that feature. See (https://buttplug-spec.docs.buttplug.io/enumeration.html#message-attributes-for-devicelist-and-deviceadded) for details.

Constructors

MessageAttributes
Fields attrFeatureCount :: Maybe Word attrStepCount :: Maybe [Word]

Instances

Instances details

Eq MessageAttributes Source #
Instance details Defined in Buttplug.Core.Device Methods (==) :: MessageAttributes -> MessageAttributes -> Bool # (/=) :: MessageAttributes -> MessageAttributes -> Bool #
Show MessageAttributes Source #
Instance details Defined in Buttplug.Core.Device Methods showsPrec :: Int -> MessageAttributes -> ShowS # show :: MessageAttributes -> String # showList :: [MessageAttributes] -> ShowS #
Generic MessageAttributes Source #
Instance details Defined in Buttplug.Core.Device Associated Types type Rep MessageAttributes :: Type -> Type # Methods from :: MessageAttributes -> Rep MessageAttributes x # to :: Rep MessageAttributes x -> MessageAttributes #
FromJSON MessageAttributes Source #
Instance details Defined in Buttplug.Core.Device Methods parseJSON :: Value -> Parser MessageAttributes parseJSONList :: Value -> Parser [MessageAttributes]
ToJSON MessageAttributes Source #
Instance details Defined in Buttplug.Core.Device Methods toJSON :: MessageAttributes -> Value toEncoding :: MessageAttributes -> Encoding toJSONList :: [MessageAttributes] -> Value toEncodingList :: [MessageAttributes] -> Encoding
type Rep MessageAttributes Source #
Instance details Defined in Buttplug.Core.Device type Rep MessageAttributes = D1 ('MetaData "MessageAttributes" "Buttplug.Core.Device" "buttplug-hs-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "MessageAttributes" 'PrefixI 'True) (S1 ('MetaSel ('Just "attrFeatureCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Word)) :*: S1 ('MetaSel ('Just "attrStepCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Word]))))

data Device Source #

An intimate device, containing info about the functionality it supports.

Constructors

Device
Fields deviceName :: Text deviceIndex :: Word deviceMessages :: Map DeviceMessageType MessageAttributes

Instances

Instances details

Eq Device Source #
Instance details Defined in Buttplug.Core.Device Methods (==) :: Device -> Device -> Bool # (/=) :: Device -> Device -> Bool #
Show Device Source #
Instance details Defined in Buttplug.Core.Device Methods showsPrec :: Int -> Device -> ShowS # show :: Device -> String # showList :: [Device] -> ShowS #
Generic Device Source #
Instance details Defined in Buttplug.Core.Device Associated Types type Rep Device :: Type -> Type # Methods from :: Device -> Rep Device x # to :: Rep Device x -> Device #
FromJSON Device Source #
Instance details Defined in Buttplug.Core.Device Methods parseJSON :: Value -> Parser Device parseJSONList :: Value -> Parser [Device]
ToJSON Device Source #
Instance details Defined in Buttplug.Core.Device Methods toJSON :: Device -> Value toEncoding :: Device -> Encoding toJSONList :: [Device] -> Value toEncodingList :: [Device] -> Encoding
type Rep Device Source #
Instance details Defined in Buttplug.Core.Device type Rep Device = D1 ('MetaData "Device" "Buttplug.Core.Device" "buttplug-hs-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "Device" 'PrefixI 'True) (S1 ('MetaSel ('Just "deviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "deviceIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word) :: S1 ('MetaSel ('Just "deviceMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map DeviceMessageType MessageAttributes)))))

data DeviceMessageType Source #

Represents which message types the device supports See (https://buttplug-spec.docs.buttplug.io/enumeration.html#message-attributes-for-devicelist-and-deviceadded) for details.

Constructors

DevRawWriteCmd
DevRawReadCmd
DevRawSubscribeCmd
DevRawUnsubscribeCmd
DevStopDeviceCmd
DevVibrateCmd
DevLinearCmd
DevRotateCmd

Instances

Instances details

Eq DeviceMessageType Source #
Instance details Defined in Buttplug.Core.Device Methods (==) :: DeviceMessageType -> DeviceMessageType -> Bool # (/=) :: DeviceMessageType -> DeviceMessageType -> Bool #
Ord DeviceMessageType Source #
Instance details Defined in Buttplug.Core.Device Methods compare :: DeviceMessageType -> DeviceMessageType -> Ordering # (<) :: DeviceMessageType -> DeviceMessageType -> Bool # (<=) :: DeviceMessageType -> DeviceMessageType -> Bool # (>) :: DeviceMessageType -> DeviceMessageType -> Bool # (>=) :: DeviceMessageType -> DeviceMessageType -> Bool # max :: DeviceMessageType -> DeviceMessageType -> DeviceMessageType # min :: DeviceMessageType -> DeviceMessageType -> DeviceMessageType #
Show DeviceMessageType Source #
Instance details Defined in Buttplug.Core.Device Methods showsPrec :: Int -> DeviceMessageType -> ShowS # show :: DeviceMessageType -> String # showList :: [DeviceMessageType] -> ShowS #
Generic DeviceMessageType Source #
Instance details Defined in Buttplug.Core.Device Associated Types type Rep DeviceMessageType :: Type -> Type # Methods from :: DeviceMessageType -> Rep DeviceMessageType x # to :: Rep DeviceMessageType x -> DeviceMessageType #
FromJSON DeviceMessageType Source #
Instance details Defined in Buttplug.Core.Device Methods parseJSON :: Value -> Parser DeviceMessageType parseJSONList :: Value -> Parser [DeviceMessageType]
FromJSONKey DeviceMessageType Source #
Instance details Defined in Buttplug.Core.Device Methods fromJSONKey :: FromJSONKeyFunction DeviceMessageType fromJSONKeyList :: FromJSONKeyFunction [DeviceMessageType]
ToJSON DeviceMessageType Source #
Instance details Defined in Buttplug.Core.Device Methods toJSON :: DeviceMessageType -> Value toEncoding :: DeviceMessageType -> Encoding toJSONList :: [DeviceMessageType] -> Value toEncodingList :: [DeviceMessageType] -> Encoding
ToJSONKey DeviceMessageType Source #
Instance details Defined in Buttplug.Core.Device Methods toJSONKey :: ToJSONKeyFunction DeviceMessageType toJSONKeyList :: ToJSONKeyFunction [DeviceMessageType]
type Rep DeviceMessageType Source #
Instance details Defined in Buttplug.Core.Device type Rep DeviceMessageType = D1 ('MetaData "DeviceMessageType" "Buttplug.Core.Device" "buttplug-hs-core-0.1.0.0-inplace" 'False) (((C1 ('MetaCons "DevRawWriteCmd" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DevRawReadCmd" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "DevRawSubscribeCmd" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DevRawUnsubscribeCmd" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "DevStopDeviceCmd" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DevVibrateCmd" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "DevLinearCmd" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DevRotateCmd" 'PrefixI 'False) (U1 :: Type -> Type))))