Constructor
new Emcy(eds)
- Source:
- Implements:
- See:
-
- CiA301 "Emergency object" (ยง7.2.7)
Parameters:
| Name | Type | Description |
|---|---|---|
eds |
Eds | Eds object. |
Members
cobId :number
- Description:
Get object 0x1014 - COB-ID EMCY.
- Source:
- Deprecated:
- Use Eds#getEmcyCobId instead.
Get object 0x1014 - COB-ID EMCY.
Type:
- number
cobId :number
- Description:
Set object 0x1014 - COB-ID EMCY.
- Source:
- Deprecated:
- Use Eds#setEmcyCobId instead.
Set object 0x1014 - COB-ID EMCY.
Type:
- number
inhibitTime :number
- Description:
Get object 0x1015 - Inhibit time EMCY.
- Source:
- Deprecated:
- Use Eds#getEmcyInhibitTime instead.
Get object 0x1015 - Inhibit time EMCY.
Type:
- number
inhibitTime :number
- Description:
Set object 0x1015 - Inhibit time EMCY.
- Source:
- Deprecated:
- Use Eds#setEmcyInhibitTime instead.
Set object 0x1015 - Inhibit time EMCY.
Type:
- number
register :number
- Description:
Get object 0x1001 - Error register.
- Source:
- Deprecated:
- Use Eds#getErrorRegister instead.
Get object 0x1001 - Error register.
Type:
- number
register :number
- Description:
Set object 0x1001 - Error register.
- Source:
- Deprecated:
- Use Eds#setErrorRegister instead.
Set object 0x1001 - Error register.
Type:
- number
valid :boolean
- Description:
Get object 0x1014 [bit 31] - EMCY valid.
- Source:
- Deprecated:
- Use Eds#getEmcyValid instead.
Get object 0x1014 [bit 31] - EMCY valid.
Type:
- boolean
valid :boolean
- Description:
Set object 0x1014 [bit 31] - EMCY valid.
- Source:
- Deprecated:
- Use Eds#setEmcyValid instead.
Set object 0x1014 [bit 31] - EMCY valid.
Type:
- boolean
Methods
init()
- Description:
Initialize the device and audit the object dictionary.
- Source:
- Deprecated:
- Use Emcy#start instead.
receive(message)
- Description:
Call when a new CAN message is received.
- Source:
- Implements:
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
message |
object | CAN frame. Properties
|
Fires:
setHistoryLength(length)
- Description:
Configures the number of sub-entries for 0x1003 (Pre-defined error field).
- Source:
- Deprecated:
- Use Eds#setHistoryLength instead.
Parameters:
| Name | Type | Description |
|---|---|---|
length |
number | how many historical error events should be kept. |
start()
- Description:
Start the module.
- Source:
- Implements:
Fires:
stop()
- Description:
Stop the module.
- Source:
- Implements:
Fires:
write(…args)
- Description:
Service: EMCY write.
- Source:
Parameters:
| Name | Type | Attributes | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
args |
object |
<repeatable> |
arguments. Properties
|
Events
emergency
- Description:
An emergency message was received.
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
cobId |
number | message identifier. |
em |
EmcyMessage | message object. |
Type:
- object