MicroLogic X Get and Reset Commands
List of Commands
The following table lists the MicroLogic X get and reset commands, their corresponding command codes, and user profiles:
Command |
Command code |
User profile |
---|---|---|
Get date time Get Date Time |
768 |
No password required |
Reset events Reset Events |
50056 |
Administrator or Operator |
Get events Get Events Procedure |
50560 |
No password required |
Get list of Digital Modules Get List of Digital Modules |
50816 |
No password required |
Get Digital Modules details Get Digital Module Details |
50817 |
No password required |
Get Date Time
To get the date and time of the MicroLogic X control unit, set the command registers in the following way:
Address |
Register |
Unit |
Type |
Range |
Description |
---|---|---|---|---|---|
0x1F3F |
8000 |
– |
INT16U |
768 |
Requested command code |
0x1F40 |
8001 |
– |
INT16U |
10 |
Number of parameters of the command |
0x1F41 |
8002 |
– |
INT16U |
5376 (0x1500) |
Destination of the command |
0x1F42 |
8003 |
– |
INT16U |
0 |
Security type of the command |
0x1F43–0x1F44 |
8004–8005 |
– |
OCTET STRING |
0 |
Password of the command = 0 (no password required) |
The date and time of the MicroLogic X control unit is returned to command registers in the following way:
Address |
Register |
Unit |
Type |
Range |
Description |
---|---|---|---|---|---|
0x1F53 |
8020 |
– |
INT16U |
768 |
Last command code |
0x1F54 |
8021 |
– |
INT16U |
– |
Command status:
|
0x1F55 |
8022 |
– |
INT16U |
8 |
Number of bytes returned |
0x1F56–0x1F59 |
8023–8026 |
– |
XDATE |
– |
Current date/time of the source |
Reset Events
To reset events, set the command registers in the following way:
Address |
Register |
Unit |
Type |
Range |
Description |
---|---|---|---|---|---|
0x1F3F |
8000 |
– |
INT16U |
50056 |
Requested command code |
0x1F40 |
8001 |
– |
INT16U |
10 |
Number of parameters of the command |
0x1F41 |
8002 |
– |
INT16U |
5377 |
Destination of the command |
0x1F42 |
8003 |
– |
INT16U |
1 |
Security type of the command |
0x1F43–0x1F44 |
8004–8005 |
– |
OCTET STRING |
0 |
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 |
– |
Requested command code |
0x1F40 |
8001 |
– |
INT16U |
27 |
– |
Number of parameters of the command |
0x1F41 |
8002 |
– |
INT16U |
5377 (0x1501) |
– |
Destination of the command |
0x1F42 |
8003 |
– |
INT16U |
0 |
– |
Security type of the command |
0x1F43–0x1F44 |
8004–8005 |
– |
OCTET STRING |
0 |
– |
Password of the command = 0 (no password required) |
0x1F45 |
8006 |
– |
INT16U |
– |
– |
Requested event log book |
0 |
Trip |
|||||
1 |
Protection |
|||||
2 |
Diagnostic |
|||||
3 |
Metering |
|||||
4 |
Configuration |
|||||
5 |
Operation |
|||||
6 |
Communication |
|||||
7–15 |
Reserved |
|||||
0x1F46 |
8007 |
– |
INT16U |
0–2 |
– |
Requested get event method Get Events Procedure:
|
0x1F47–0x1F4A |
8008–8011 |
– |
DATETIME |
– |
– |
Requested event date time (for method 1 only) |
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 |
– |
INT16U |
– |
– |
Responded event log book |
0 |
Trip |
|||||
1 |
Protection |
|||||
2 |
Diagnostic |
|||||
3 |
Metering |
|||||
4 |
Configuration |
|||||
5 |
Operation |
|||||
6 |
Communication |
|||||
7–15 |
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 |
0–10 |
– |
MSB: Number of events returned |
0–1 |
– |
LSB: Remaining events
|
||||
0x1F60 |
8033 |
– |
INT16U |
1013-25630 |
– |
First event code Event Characteristics. |
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 |
– |
INT16U |
1–255 |
– |
First event log book |
0 |
Trip |
|||||
1 |
Protection |
|||||
2 |
Diagnostic |
|||||
3 |
Metering |
|||||
4 |
Configuration |
|||||
5 |
Operation |
|||||
6 |
Communication |
|||||
7–15 |
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 three following methods:
-
get the most recent events
-
get events logged before and up to a date
-
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.
NOTE: You can detect the occurrence of a new event by reading the last event sequence number available in registers 655–656 Last Event Data.
The command allows to get 10 events maximum, logged in one or several event log books, 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 any of the other two methods (get events logged before and up to a date or get events before and up to an event sequence number) to get rest of the events.
Example 1: Read the new events in all log books
The following diagram shows the steps to follow to read the new events in all log books:
Example 2: Read all events in the protection log book
The following diagram shows the steps to follow to read all events in the protection log book:
Get List of Digital Modules
To get the list of Digital Modules of the MicroLogic X control unit, set the command registers in the following way:
Address |
Register |
Unit |
Type |
Range |
Description |
---|---|---|---|---|---|
0x1F3F |
8000 |
– |
INT16U |
50816 |
Requested command code |
0x1F40 |
8001 |
– |
INT16U |
12 |
Number of parameters of the command |
0x1F41 |
8002 |
– |
INT16U |
5377 (0x1501) |
Destination of the command |
0x1F42 |
8003 |
– |
INT16U |
0 |
Security type of the command |
0x1F43–0x1F44 |
8004–8005 |
– |
OCTET STRING |
0 |
Password of the command = 0 (no password required) |
0x1F45–0x1F46 |
8006 |
– |
INT16U |
0 |
All Digital Modules |
The list of Digital Modules of the MicroLogic X control unit is returned to command registers in the following way:
Address |
Register |
Unit |
Type |
Range |
Description |
---|---|---|---|---|---|
0x1F53 |
8020 |
– |
INT16U |
50816 |
Last command code |
0x1F54 |
8021 |
– |
INT16U |
– |
Command status:
|
0x1F55 |
8022 |
– |
INT16U |
– |
Number of bytes returned |
0x1F56 |
8023 |
– |
INT16U |
0 |
All Digital Modules |
0x1F57 |
8024 |
– |
INT16U |
0–14 |
Number of Digital Modules returned |
0x1F58 |
8025 |
– |
INT16U |
1–13 15 |
First Digital Module firmware identifier entry:
|
0x1F59 |
8026 |
– |
INT16U |
1–13 15 |
Second Digital Module firmware identifier entry |
0x1F5A |
8027 |
– |
INT16U |
1–13 15 |
Third Digital Module firmware identifier entry |
0x1F5B |
8028 |
– |
INT16U |
1–13 15 |
Fourth Digital Module firmware identifier entry |
0x1F5C |
8029 |
– |
INT16U |
1–13 15 |
Fifth Digital Module firmware identifier entry |
0x1F5D |
8030 |
– |
INT16U |
1–13 15 |
Sixth Digital Module firmware identifier entry |
0x1F5E |
8031 |
– |
INT16U |
1–13 15 |
Seventh Digital Module firmware identifier entry |
0x1F5F |
8032 |
– |
INT16U |
1–13 15 |
Eighth Digital Module firmware identifier entry |
0x1F60 |
8033 |
– |
INT16U |
1–13 15 |
Ninth Digital Module firmware identifier entry |
0x1F61 |
8034 |
– |
INT16U |
1–13 15 |
Tenth Digital Module firmware identifier entry |
0x1F62 |
8035 |
– |
INT16U |
1–13 15 |
Eleventh Digital Module firmware identifier entry |
0x1F63 |
8036 |
– |
INT16U |
1–13 15 |
Twelfth Digital Module firmware identifier entry |
0x1F64 |
8037 |
– |
INT16U |
1–13 15 |
Thirteenth Digital Module firmware identifier entry |
0x1F65 |
8038 |
– |
INT16U |
1–13 15 |
Fourteenth Digital Module firmware identifier entry |
Get Digital Module Details
To get the details of one Digital Module of the MicroLogic X control unit, set the command registers in the following way:
Address |
Register |
Unit |
Type |
Range |
Description |
---|---|---|---|---|---|
0x1F3F |
8000 |
– |
INT16U |
50817 |
Requested command code |
0x1F40 |
8001 |
– |
INT16U |
12 |
Number of parameters of the command |
0x1F41 |
8002 |
– |
INT16U |
5377 (0x1501) |
Destination of the command |
0x1F42 |
8003 |
– |
INT16U |
0 |
Security type of the command |
0x1F43–0x1F44 |
8004–8005 |
– |
OCTET STRING |
0 |
Password of the command = 0 (no password required) |
0x1F45–0x1F46 |
8006 |
– |
INT16U |
1–13 15 |
Requested Digital Module entry:
|
The Digital Module details of the MicroLogic X control unit is returned to command registers in the following way:
Address |
Register |
Unit |
Type |
Range |
Description |
---|---|---|---|---|---|
0x1F53 |
8020 |
– |
INT16U |
50817 |
Last command code |
0x1F54 |
8021 |
– |
INT16U |
– |
Command status:
|
0x1F55 |
8022 |
– |
INT16U |
124 |
Number of bytes returned |
0x1F56 |
8023 |
– |
INT16U |
1–13 15 |
Responded Digital Module entry:
|
0x1F57–0x1F5E |
8024–8031 |
– |
OCTET STRING |
– |
Digital Module product code (commercial reference) |
0x1F5F–0x1F86 |
8032–8071 |
– |
OCTET STRING |
– |
Digital Module model name |
0x1F87–0x1F8C |
8072–8077 |
– |
OCTET STRING |
– |
Digital Module firmware revision |
0x1F8D |
8078 |
– |
– |
– |
Reserved |
0x1F8E |
8079 |
– |
INT16U |
– |
MSB: Digital Module license type
|
LSB: Digital Module activation
|
|||||
0x1F8F |
8080 |
Days |
INT16U |
0–65534 |
Digital Module license remaining days (only for temporary license installed) |
0x1F90–0x1F93 |
8081–8084 |
– |
– |
– |
Reserved |