| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Text.Kcd.Parser
Description
import qualified Kcd.Parser as KCD main = do kcd <- KCD.parseKcdFile "example.kcd" print kcd
- parseKcdFile :: String -> IO NetworkDefinition
- parseNetworkDefinition :: MonadThrow m => ConduitM Event o m (Maybe NetworkDefinition)
- data BasicLabelTypeValue
- data Bus = Bus {
- _busMessages :: [Message]
- _busName :: Text
- _busBaudrate :: Int
- data Consumer = Consumer {
- _consumerNodeRef :: [NodeRef]
- data Document = Document {}
- data Endianess
- data Label = Label {}
- data LabelGroup = LabelGroup {}
- data LabelSet = LabelSet {
- _labelSetLabel :: [Label]
- _labelSetLabelGroup :: [LabelGroup]
- data Message = Message {}
- newtype MessageId = MessageId {
- _unMessageId :: Int
- data MessageLength
- = Auto
- | LengthValue Int
- data Multiplex = Multiplex {}
- data MuxGroup = MuxGroup {
- _muxGroupSignals :: [Signal]
- _muxGroupCount :: Int
- data NetworkDefinition = NetworkDefinition {}
- data Node = Node {}
- data NodeRef = NodeRef {
- _nodeRefId :: Text
- newtype Notes = Notes Text
- data Producer = Producer {
- _producerNodeRef :: [NodeRef]
- data Signal = Signal {}
- data Value = Value {}
- data ValueType
- data Var = Var {}
Documentation
parseKcdFile :: String -> IO NetworkDefinition Source #
parseNetworkDefinition :: MonadThrow m => ConduitM Event o m (Maybe NetworkDefinition) Source #
network transport system that transfers the data between several nodes.
Constructors
| Bus | |
Fields
| |
Network node that is a user/receiver of the assigned signal.
Constructors
| Consumer | |
Fields
| |
Describes the scope of application e.g. the target vehicle or controlled device.
Constructors
| Document | |
Fields
| |
Constructors
| LittleEndian | |
| BigEndian |
Descriptive name for a single value e.g. to describe an enumeration, mark special,invalid or error values.
Constructors
| Label | |
Fields
| |
data LabelGroup Source #
Constructors
| LabelGroup | |
Fields
| |
Instances
Constructors
| LabelSet | |
Fields
| |
Constructors
| Message | |
Fields
| |
Constructors
| MessageId | |
Fields
| |
A looping counter to make a group of signals (MuxGroup) alternately active at a time.
Constructors
| Multiplex | |
Fields
| |
A group of signals that is just valid when the count value of the group matches with the looping | counter (Multiplex).
Constructors
| MuxGroup | |
Fields
| |
data NetworkDefinition Source #
Definition of one or more CAN bus networks in one file.
Constructors
| NetworkDefinition | |
Fields | |
Instances
An endpoint connected to the network (e.g. an electronic control unit) that is able to | send messages to or receive messages from other endpoints.
Constructors
| Node | |
An endpoint connected to the network that is able to send messages to or receive messages from other endpoints.
Constructors
| NodeRef | |
Fields
| |
Describes the purpose of the signalvariable andor comments on its usage.
Origin network node that is the sender of the assigned message.
Constructors
| Producer | |
Fields
| |
A discrete part of information contained in the payload of a message.
Constructors
| Signal | |
Fields
| |
Details of how the raw value of the signal/variable shall be interpreted.
Constructors
| Value | |
Fields
| |