Base device class for communicating with an RS485 slave. More...

#include <Device.h>

Inheritance diagram for IO::RS485::Device:
Collaboration diagram for IO::RS485::Device:

Classes

struct  Config
 RS485 configuration. More...
 
class  FactoryTemplate
 

Public Member Functions

 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)
 
virtual RequestcreateRequest ()=0
 Create a request object for this device. More...
 
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
 

Protected Member Functions

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)
 

Additional Inherited Members

- Public Types inherited from IO::Device
enum  State { State::stopped, State::starting, State::fault, State::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 & >
 
- Protected Attributes inherited from IO::Device
Controllercontroller
 

Detailed Description

Base device class for communicating with an RS485 slave.

Constructor & Destructor Documentation

◆ Device()

IO::RS485::Device::Device ( Controller controller,
const char *  id 
)
inline

Member Function Documentation

◆ address()

uint16_t IO::RS485::Device::address ( ) const
inlineoverridevirtual

Devices with a numeric address should implement this method.

Reimplemented from IO::Device.

◆ baudrate()

unsigned IO::RS485::Device::baudrate ( ) const
inline

◆ getController()

Controller& IO::RS485::Device::getController ( )
inline

◆ handleEvent()

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

Implementations may override this method to customise event handling.

Reimplemented from IO::Device.

◆ init() [1/2]

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

◆ init() [2/2]

ErrorCode IO::RS485::Device::init ( JsonObjectConst  config)
overridevirtual

Implements IO::Device.

◆ parseJson()

void IO::RS485::Device::parseJson ( JsonObjectConst  json,
Config cfg 
)
protected

◆ segment()

uint8_t IO::RS485::Device::segment ( ) const
inline

◆ timeout()

unsigned IO::RS485::Device::timeout ( ) const
inline

◆ type()

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

Implements IO::Device.


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