A virtual device, represents a modbus slave device. More...

#include <Device.h>

Inheritance diagram for IO::Modbus::Device:
Collaboration diagram for IO::Modbus::Device:

Classes

class  Factory
 

Public Types

using TransferCallback = void(*)(const void *data, size_t length, bool send)
 
- Public Types inherited from IO::Device
enum class  State { stopped , starting , fault , normal }
 
using OwnedList = OwnedLinkedObjectListTemplate< Device >
 
- Public Types inherited from LinkedObjectTemplate< Device >
using Iterator = IteratorTemplate< Device, Device *, Device & >
 
using ConstIterator = IteratorTemplate< const Device, const Device *, const Device & >
 

Public Member Functions

ErrorCode init (const Config &config)
 
const DeviceType type () const override
 
virtual void onBroadcast (const ADU &adu)
 Handle a broadcast message. More...
 
virtual void onRequest (ADU &adu)
 Handle a message specifically for this device. More...
 
IO::RequestcreateRequest () override
 Create a request object for this device. More...
 
void handleEvent (IO::Request *request, Event event) override
 Implementations may override this method to customise event handling. More...
 
- Public Member Functions inherited from IO::RS485::Device
 Device (Controller &controller, const char *id)
 
ErrorCode init (const Config &config)
 
ErrorCode init (JsonObjectConst config) override
 
const DeviceType type () const override
 
ControllergetController ()
 
uint16_t address () const override
 Devices with a numeric address should implement this method. More...
 
uint8_t segment () const
 
unsigned baudrate () const
 
unsigned timeout () const
 
void handleEvent (IO::Request *request, Event event) override
 Implementations may override this method to customise event handling. More...
 
- Public Member Functions inherited from IO::Device
 Device (Controller &controller, const char *id)
 Device constructor. More...
 
virtual ~Device ()
 
ErrorCode init (const Config &config)
 
const CStringgetId () const
 The unique device identifier. More...
 
bool operator== (const String &id) const
 
const CStringgetName () const
 Optional descriptive name for the device. More...
 
unsigned minTransactionInterval () const
 
String caption () const
 Obtain a descriptive caption for this device. More...
 
ControllergetController () const
 Obtain the owning controller. More...
 
State getState ()
 Get current device state. More...
 
virtual DevNode::ID nodeIdMin () const
 Get minimum valid Node ID for this device. More...
 
DevNode::ID nodeIdMax () const
 Get maximum valid Node ID for this device. More...
 
virtual uint16_t maxNodes () const
 Determine maximum number of nodes supported by the device. More...
 
virtual DevNode::States getNodeStates (DevNode node) const
 Return the current set of states for all nodes controlled by this device. More...
 
- Public Member Functions inherited from LinkedObjectTemplate< Device >
Device * getNext () const
 
bool insertAfter (Device *object)
 
Iterator begin () const
 
Iterator end () const
 
Iterator cbegin () const
 
Iterator cend () const
 
- Public Member Functions inherited from LinkedObject
virtual ~LinkedObject ()
 
virtual LinkedObjectnext () const
 
bool insertAfter (LinkedObject *object)
 
bool operator== (const LinkedObject &other) const
 
bool operator!= (const LinkedObject &other) const
 

Static Public Member Functions

static void onTransfer (TransferCallback callback)
 

Static Public Attributes

static const Factory factory
 

Additional Inherited Members

- Protected Member Functions inherited from IO::RS485::Device
void parseJson (JsonObjectConst json, Config &cfg)
 
- Protected Member Functions inherited from IO::Device
void parseJson (JsonObjectConst json, Config &cfg)
 
virtual ErrorCode start ()
 
virtual ErrorCode stop ()
 
void submit (Request *request)
 
- Protected Attributes inherited from IO::Device
Controllercontroller
 

Detailed Description

A virtual device, represents a modbus slave device.

Actual devices must implement:

Member Typedef Documentation

◆ TransferCallback

using IO::Modbus::Device::TransferCallback = void (*)(const void* data, size_t length, bool send)

Member Function Documentation

◆ createRequest()

IO::Request* IO::Modbus::Device::createRequest ( )
overridevirtual

Create a request object for this device.

Return values
Request*Caller must destroy or submit the request

Implements IO::Device.

Reimplemented in IO::Modbus::STS::Fan::Device, IO::Modbus::STM8Relay::Device, IO::Modbus::RID35::Device, IO::Modbus::R421A::Device, and IO::Modbus::NT18B07::Device.

◆ handleEvent()

void IO::Modbus::Device::handleEvent ( IO::Request request,
Event  event 
)
overridevirtual

Implementations may override this method to customise event handling.

Reimplemented from IO::Device.

Reimplemented in IO::Modbus::STM8Relay::Device, and IO::Modbus::R421A::Device.

◆ init()

ErrorCode IO::Modbus::Device::init ( const Config config)

◆ onBroadcast()

virtual void IO::Modbus::Device::onBroadcast ( const ADU adu)
inlinevirtual

Handle a broadcast message.

◆ onRequest()

virtual void IO::Modbus::Device::onRequest ( ADU adu)
inlinevirtual

Handle a message specifically for this device.

◆ onTransfer()

static void IO::Modbus::Device::onTransfer ( TransferCallback  callback)
inlinestatic

◆ type()

const DeviceType IO::Modbus::Device::type ( ) const
inlineoverridevirtual

Implements IO::Device.

Member Data Documentation

◆ factory

const Factory IO::Modbus::Device::factory
static

The documentation for this class was generated from the following file: