Safe Haskell	None
Language	Haskell2010

Network.SakuraIO.Platform.Message

Description

This module provides Haskell representation of messages exchanged on the sakura.io platform.

https://sakura.io/docs/pages/spec/platform/message.html

Synopsis

type ModuleID = String
data OutGoingMessage
- = OGChannels ModuleID UTCTime [OGChannel]
- | OGConnection ModuleID UTCTime Bool
- | OGLocation ModuleID UTCTime (Maybe Coordinate)
- | OGKeepalive UTCTime
type ChannelID = Word8
data OGChannel = OGChannel ChannelID UTCTime ChannelValue
type Latitude = Float
type Longitude = Float
type RangeM = Int32
data Coordinate = Coordinate Latitude Longitude RangeM
data InComingMessage = ICChannels ModuleID [ICChannel]
data ICChannel = ICChannel ChannelID ChannelValue
data ChannelValue
- = CVInt32 Int32
- | CVWord32 Word32
- | CVInt64 Int64
- | CVWord64 Word64
- | CVFloat Float
- | CVDouble Double
- | CVBytes ByteString

Documentation

type ModuleID = String Source #

Module ID starting with 'u'.

data OutGoingMessage Source #

Messages sent from sakura.io to external services.

It supports FromJSON to parse from json using aeson.

Constructors

OGChannels ModuleID UTCTime [OGChannel]
OGConnection ModuleID UTCTime Bool
OGLocation ModuleID UTCTime (Maybe Coordinate)
OGKeepalive UTCTime

Instances

Eq OutGoingMessage Source #
Instance details Defined in Network.SakuraIO.Platform.Message Methods (==) :: OutGoingMessage -> OutGoingMessage -> Bool # (/=) :: OutGoingMessage -> OutGoingMessage -> Bool #
Show OutGoingMessage Source #
Instance details Defined in Network.SakuraIO.Platform.Message Methods showsPrec :: Int -> OutGoingMessage -> ShowS # show :: OutGoingMessage -> String # showList :: [OutGoingMessage] -> ShowS #
FromJSON OutGoingMessage Source #
Instance details Defined in Network.SakuraIO.Platform.Message Methods parseJSON :: Value -> Parser OutGoingMessage # parseJSONList :: Value -> Parser [OutGoingMessage] #

type ChannelID = Word8 Source #

7bit channel number.

data OGChannel Source #

Channel payload sent from sakura.io to external services as part of OGChannels.

It supports FromJSON to parse from json using aeson.

Constructors

OGChannel ChannelID UTCTime ChannelValue

Instances

Eq OGChannel Source #
Instance details Defined in Network.SakuraIO.Platform.Message Methods (==) :: OGChannel -> OGChannel -> Bool # (/=) :: OGChannel -> OGChannel -> Bool #
Show OGChannel Source #
Instance details Defined in Network.SakuraIO.Platform.Message Methods showsPrec :: Int -> OGChannel -> ShowS # show :: OGChannel -> String # showList :: [OGChannel] -> ShowS #
FromJSON OGChannel Source #
Instance details Defined in Network.SakuraIO.Platform.Message Methods parseJSON :: Value -> Parser OGChannel # parseJSONList :: Value -> Parser [OGChannel] #

type Latitude = Float Source #

Latitude.

type Longitude = Float Source #

Longitude.

type RangeM = Int32 Source #

Range in meters.

data Coordinate Source #

Coordinate payload sent from sakura.io to external services as part of OGLocation.

It supports FromJSON to get json representation using aeson.

Constructors

Coordinate Latitude Longitude RangeM

Instances

Eq Coordinate Source #
Instance details Defined in Network.SakuraIO.Platform.Message Methods (==) :: Coordinate -> Coordinate -> Bool # (/=) :: Coordinate -> Coordinate -> Bool #
Show Coordinate Source #
Instance details Defined in Network.SakuraIO.Platform.Message Methods showsPrec :: Int -> Coordinate -> ShowS # show :: Coordinate -> String # showList :: [Coordinate] -> ShowS #
FromJSON Coordinate Source #
Instance details Defined in Network.SakuraIO.Platform.Message Methods parseJSON :: Value -> Parser Coordinate # parseJSONList :: Value -> Parser [Coordinate] #

data InComingMessage Source #

Messages sent from external services to sakura.io.

It supports ToJSON to get json representation using aeson.

Constructors

ICChannels ModuleID [ICChannel]

Instances

Eq InComingMessage Source #
Instance details Defined in Network.SakuraIO.Platform.Message Methods (==) :: InComingMessage -> InComingMessage -> Bool # (/=) :: InComingMessage -> InComingMessage -> Bool #
Show InComingMessage Source #
Instance details Defined in Network.SakuraIO.Platform.Message Methods showsPrec :: Int -> InComingMessage -> ShowS # show :: InComingMessage -> String # showList :: [InComingMessage] -> ShowS #
ToJSON InComingMessage Source #
Instance details Defined in Network.SakuraIO.Platform.Message Methods toJSON :: InComingMessage -> Value # toEncoding :: InComingMessage -> Encoding # toJSONList :: [InComingMessage] -> Value # toEncodingList :: [InComingMessage] -> Encoding #

data ICChannel Source #

Channel payload sent from external services to sakura.io as part of ICChannels.

It supports ToJSON to get json representation using aeson.

Constructors

ICChannel ChannelID ChannelValue

Instances

Eq ICChannel Source #
Instance details Defined in Network.SakuraIO.Platform.Message Methods (==) :: ICChannel -> ICChannel -> Bool # (/=) :: ICChannel -> ICChannel -> Bool #
Show ICChannel Source #
Instance details Defined in Network.SakuraIO.Platform.Message Methods showsPrec :: Int -> ICChannel -> ShowS # show :: ICChannel -> String # showList :: [ICChannel] -> ShowS #
ToJSON ICChannel Source #
Instance details Defined in Network.SakuraIO.Platform.Message Methods toJSON :: ICChannel -> Value # toEncoding :: ICChannel -> Encoding # toJSONList :: [ICChannel] -> Value # toEncodingList :: [ICChannel] -> Encoding #

data ChannelValue Source #

Data exchanged between sakura.io and external services as part of OGChannel and ICChannel.

Constructors

CVInt32 Int32
CVWord32 Word32
CVInt64 Int64
CVWord64 Word64
CVFloat Float
CVDouble Double
CVBytes ByteString

Instances

Eq ChannelValue Source #
Instance details Defined in Network.SakuraIO.Platform.Message Methods (==) :: ChannelValue -> ChannelValue -> Bool # (/=) :: ChannelValue -> ChannelValue -> Bool #
Show ChannelValue Source #
Instance details Defined in Network.SakuraIO.Platform.Message Methods showsPrec :: Int -> ChannelValue -> ShowS # show :: ChannelValue -> String # showList :: [ChannelValue] -> ShowS #