IO::Modbus::Device Class Reference
A virtual device, represents a modbus slave device. More...
#include <Device.h>
Inheritance diagram for IO::Modbus::Device:
Collaboration diagram for IO::Modbus::Device:
Public Member Functions | |
| ErrorCode | init (const RS485::Device::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... | |
| 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 |
| Controller & | getController () |
| uint16_t | address () const override |
| Devices with a numeric address should implement this method. More... | |
| uint8_t | segment () const |
| unsigned | baudrate () 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 Request * | createRequest ()=0 |
| Create a request object for this device. More... | |
| const CString & | getId () const |
| The unique device identifier. More... | |
| bool | operator== (const String &id) const |
| const CString & | getName () const |
| Optional descriptive name for the device. More... | |
| String | caption () const |
| Obtain a descriptive caption for this device. More... | |
| Controller & | getController () 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... | |
| virtual 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 devicce. 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 LinkedObject * | next () const |
| bool | insertAfter (LinkedObject *object) |
| bool | operator== (const LinkedObject &other) const |
| bool | operator!= (const LinkedObject &other) const |
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 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 | |
| Controller & | controller |
Detailed Description
A virtual device, represents a modbus slave device.
Actual devices must implement:
- createRequest()
- callback()
- fillRequestData()
Member Function Documentation
◆ handleEvent()
|
overridevirtual |
Implementations may override this method to customise event handling.
Reimplemented from IO::Device.
Reimplemented in IO::Modbus::R421A::Device.
◆ init()
| ErrorCode IO::Modbus::Device::init | ( | const RS485::Device::Config & | config | ) |
◆ onBroadcast()
|
inlinevirtual |
Handle a broadcast message.
◆ onRequest()
|
inlinevirtual |
Handle a message specifically for this device.
◆ type()
|
inlineoverridevirtual |
Implements IO::Device.
The documentation for this class was generated from the following file:
