- Source:
- Since:
- 6.0.0
Methods
addEdsCallback(eventName, listener)
- Description:
Add a listener to the Eds.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
eventName |
string | the name of the event. |
listener |
function | the callback function. |
addUpdateCallback(entry, listener, keyopt)
- Description:
Add an 'update' listener to a DataObject.
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
entry |
DataObject | event emitter. |
|
listener |
function | event listener. |
|
key |
string |
<optional> |
event key. |
(abstract) receive(message)
- Description:
Call when a new CAN message is received.
- Source:
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
message |
object | CAN frame. Properties
|
removeEdsCallback(eventName)
- Description:
Remove a listener from the Eds.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
eventName |
string | the name of the event. |
removeUpdateCallback(entry, keyopt)
- Description:
Remove an 'update' listener from a DataObject.
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
entry |
DataObject | event emitter. |
|
key |
string |
<optional> |
event key. |
send(id, data)
- Description:
Emit a CAN message.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
number | CAN message identifier. |
data |
Buffer | CAN message data; |
Fires:
(abstract) start()
- Description:
Start the module.
- Source:
Fires:
(abstract) stop()
- Description:
Stop the module.
- Source:
Fires:
Events
message
- Description:
A CAN message is ready to send.
- Source:
- Since:
- 6.0.0
Properties:
| Name | Type | Description |
|---|---|---|
id |
number | CAN message identifier. |
data |
Buffer | CAN message data. |
Type:
- object
start
- Description:
The module has been started.
- Source:
- Since:
- 6.0.0
stop
- Description:
The module has been stopped.
- Source:
- Since:
- 6.0.0