Generic Commands
Change Output State
The command is used to change the state of IO module digital outputs assigned as user-defined outputs using the EcoStruxure Power Commission software.
To change the output state, set the command registers in the following way:
Address |
Register |
Unit |
Type |
Range |
Description |
---|---|---|---|---|---|
0x1F3F |
8000 |
– |
INT16U |
1672 |
Command code = 1672 |
0x1F40 |
8001 |
– |
INT16U |
13 |
Number of parameters (bytes) = 13 |
0x1F41 |
8002 |
– |
INT16U |
– |
Destination =
|
0x1F42 |
8003 |
– |
INT16U |
1 |
Security type of the command |
0x1F43–0x1F44 |
8004– 8005 |
– |
OCTET STRING |
– |
Password of the command: Administrator or Operator user profile password |
0x1F45 |
8006 |
– |
INT16U |
1–3 |
Output number
|
0x1F46 |
8007 |
– |
INT16U |
– |
Value to set:
|
Reset IO Module Alarm
The alarms can be read from the alarm status register.
To reset IO module alarms, set the command registers in the following way:
Address |
Register |
Unit |
Type |
Range |
Description |
---|---|---|---|---|---|
0x1F3F |
8000 |
– |
INT16U |
41099 |
Command code = 41099 |
0x1F40 |
8001 |
– |
INT16U |
10 |
Number of parameters (bytes) = 10 |
0x1F41 |
8002 |
– |
INT16U |
– |
Destination =
|
0x1F42 |
8003 |
– |
INT16U |
1 |
Security type of the command |
0x1F43–0x1F44 |
8004– 8005 |
– |
OCTET STRING |
– |
Password of the command: Administrator or Operator user profile password |
Enable/Disable Simple Commands
To enable or disable the simple commands, set the command registers in the following way:
Address |
Register |
Unit |
Type |
Range |
Description |
---|---|---|---|---|---|
0x1F3F |
8000 |
– |
INT16U |
41100 |
Command code = 41100 |
0x1F40 |
8001 |
– |
INT16U |
11 |
Number of parameters (bytes) = 11 |
0x1F41 |
8002 |
– |
INT16U |
– |
Destination =
|
0x1F42 |
8003 |
– |
INT16U |
1 |
Security type of the command |
0x1F43–0x1F44 |
8004– 8005 |
– |
OCTET STRING |
– |
Password of the command: Administrator or Operator user profile password |
0x1F45 |
8006 |
– |
INT16U |
– |
MSB: Enable or disable:
LSB: 0 (not used) |
Acknowledge Latched Output
To acknowledge the latched output, set the command registers in the following way:
Address |
Register |
Unit |
Type |
Range |
Description |
---|---|---|---|---|---|
0x1F3F |
8000 |
– |
INT16U |
41102 |
Command code = 41102 |
0x1F40 |
8001 |
– |
INT16U |
11 |
Number of parameters (bytes) = 11 |
0x1F41 |
8002 |
– |
INT16U |
– |
Destination =
|
0x1F42 |
8003 |
– |
INT16U |
1 |
Security type of the command |
0x1F43–0x1F44 |
8004– 8005 |
– |
OCTET STRING |
– |
Password of the command: Administrator or Operator user profile password |
0x1F45 |
8006 |
– |
INT16U |
– |
MSB:
LSB: 0 (not used) |
Reset Analog Input Minimum/Maximum Values
The analog input maximum and minimum values can be read from the analog input registers.
To reset the minimum/maximum analog input values, set the command registers in the following way:
Address |
Register |
Unit |
Type |
Range |
Description |
---|---|---|---|---|---|
0x1F3F |
8000 |
– |
INT16U |
42890 |
Command code = 42890 |
0x1F40 |
8001 |
– |
INT16U |
10 |
Number of parameters (bytes) = 10 |
0x1F41 |
8002 |
– |
INT16U |
– |
Destination =
|
0x1F42 |
8003 |
– |
INT16U |
1 |
Security type of the command |
0x1F43–0x1F44 |
8004– 8005 |
– |
OCTET STRING |
– |
Password of the command: Administrator or Operator user profile password |
Get Events Command
To get events, set the command registers in the following way:
Address |
Register |
Unit |
Type |
Range |
Bit |
Description |
---|---|---|---|---|---|---|
0x1F3F |
8000 |
– |
INT16U |
50560 |
– |
Command code = 50560 |
0x1F40 |
8001 |
– |
INT16U |
27 |
– |
Number of parameters (bytes) = 27 |
0x1F41 |
8002 |
– |
INT16U |
– |
– |
Destination =
|
0x1F42 |
8003 |
– |
INT16U |
0 |
– |
Security type of the command |
0x1F43–0x1F44 |
8004– 8005 |
– |
OCTET STRING |
– |
– |
Password of the command = 0 (no password required) |
0x1F45 |
8006 |
– |
– |
– |
– |
Reserved |
0x1F46 |
8007 |
– |
INT16U |
0, 2 |
– |
Requested get event method Get Events Procedure:
|
0x1F47–0x1F4A |
8008–8011 |
– |
– |
– |
– |
Reserved |
0x1F4B–0x1F4C |
8012–8013 |
– |
INT32U |
– |
– |
Requested event sequence number (for method 2 only) |
0x1F4D |
8014 |
– |
INT16U |
– |
– |
Requested event severity |
0–7 |
Reserved |
|||||
8 |
Low |
|||||
9 |
Medium |
|||||
10 |
High |
|||||
11–15 |
Reserved |
Events are returned to command registers in the following way:
Address |
Register |
Unit |
Type |
Range |
Bit |
Description |
---|---|---|---|---|---|---|
0x1F53 |
8020 |
– |
INT16U |
50560 |
– |
Last command code |
0x1F54 |
8021 |
– |
INT16U |
– |
– |
Command status:
|
0x1F55 |
8022 |
– |
INT16U |
– |
– |
Number of bytes returned |
0x1F56 |
8023 |
– |
– |
– |
– |
Reserved |
0x1F57 |
8024 |
– |
INT16U |
0, 2 |
– |
Responded get event method:
|
0x1F5E |
8031 |
– |
INT16U |
– |
– |
Responded event severity |
0–7 |
Reserved |
|||||
8 |
Low |
|||||
9 |
Medium |
|||||
10 |
High |
|||||
11–15 |
Reserved |
|||||
0x1F5F |
8032 |
– |
INT16U |
– |
– |
MSB: Number of events returned |
– |
LSB: Remaining events
|
|||||
0x1F60 |
8033 |
– |
INT16U |
1013-25630 |
– |
First event code |
0x1F61–0x1F64 |
8034–8037 |
– |
DATETIME |
– |
– |
Timestamp of the first event |
0x1F65 |
8038 |
– |
INT16U |
– |
– |
Timestamp quality of the first event |
0x1F66–0x1F67 |
8039–8040 |
– |
INT32U |
– |
– |
First event sequence number |
0x1F68 |
8041 |
– |
INT16U |
– |
– |
MSB: First event status
LSB: Reserved |
0x1F69 |
8042 |
– |
– |
– |
– |
Reserved |
0x1F6A |
8043 |
– |
INT16U |
– |
– |
First event severity |
0–7 |
Reserved |
|||||
8 |
Low |
|||||
9 |
Medium |
|||||
10 |
High |
|||||
11–15 |
Reserved |
|||||
0x1F6B–0x1F75 |
8044–8054 |
– |
INT16U |
– |
– |
Characteristics of event 2 (same as event 1) |
0x1F76–0x1F80 |
8055–8065 |
– |
INT16U |
– |
– |
Characteristics of event 3 (same as event 1) |
0x1F81– 0x1F8B |
8066–8076 |
– |
INT16U |
– |
– |
Characteristics of event 4 (same as event 1) |
0x1F8C–0x1F96 |
8077–8087 |
– |
INT16U |
– |
– |
Characteristics of event 5 (same as event 1) |
0x1F97–0x1FA1 |
8088–8098 |
– |
INT16U |
– |
– |
Characteristics of event 6 (same as event 1) |
0x1FA2–0x1FAC |
8099–8109 |
– |
INT16U |
– |
– |
Characteristics of event 7 (same as event 1) |
0x1FAD–0x1FB7 |
8110–8120 |
– |
INT16U |
– |
– |
Characteristics of event 8 (same as event 1) |
0x1FB8–0x1FC2 |
8121–8131 |
– |
INT16U |
– |
– |
Characteristics of event 9 (same as event 1) |
0x1FC3–0x1FCD |
8132–8142 |
– |
INT16U |
– |
– |
Characteristics of event 10 (same as event 1) |
Get Events Procedure
The command allows to get events by using one of the two following methods:
-
get the most recent events
-
get events before and up to an event sequence number. The event sequence number is an event identifier defined by the device, and is available among the event characteristics. It can be used to sort the events in chronological order.
The command allows to get 10 events maximum for one or several severity levels.
-
To get the 10 most recent events, use the method “get the most recent events”.
-
If there are more than 10 events, use the other method “get events before and up to an event sequence number” to get rest of the events.
Example: Read all events:
The following diagram shows the steps to follow to read all events recorded in the device: