The Elevator2MQTT protocol is used in flexyPage Diagnose to allow for monitoring and controlling the elevator settings.
Accepts the following message:
Returns the current timestamp in seconds since epoch on the device.
An integer definining the timestamp in seconds since epoch.
Accepts the following message:
Sets the current timestamp in seconds since epoch to the device. Can be used to set the time from the frontend.
An integer definining the timestamp in seconds since epoch.
Available only on servers:
Accepts the following message:
Returns the type of the interface identified by {interfaceName}.
A string describing the interface type.
CAN
Available only on servers:
Accepts the following message:
Returns the currently set ethernet configuration.
An object describing the readonly ethernet configuration parts of the given interface.
{
"enabled": true,
"nameservers": [
"8.8.8.8"
],
"ipv4": [
{
"dhcp": false,
"address": "192.168.2.9",
"netmask": "255.255.255.0",
"gateway": "192.168.2.1"
}
],
"mac": "fe:4b:7f:43:d4:0a",
"connected": true
}
Available only on servers:
Accepts the following message:
Sets the ethernet configuration.
An object describing the current ethernet configuration of the given interface.
{
"enabled": true,
"nameservers": [
"8.8.8.8"
],
"ipv4": [
{
"dhcp": false,
"address": "192.168.2.9",
"netmask": "255.255.255.0",
"gateway": "192.168.2.1"
}
]
}
Available only on servers:
Accepts the following message:
An event describing the available node IDs on this can interface.
[
1,
15
]
Available only on servers:
Accepts the following message:
An event describing available information about this node. Can also be an empty object.
A node description object containing the manufacturer, the device name, the firmware version string, and the CiA ID.
{
"manufacturerId": 0,
"manufacturer": "string",
"deviceName": "string",
"firmware": "string",
"protocol": "string",
"virtualDevices": [
{
"deviceCategory": "UNKNOWN",
"unitId": 0
}
]
}
Available only on servers:
Accepts the following message:
An event describing the activity state of this node.
device is active/inactive
Available only on servers:
Accepts the following message:
An event describing changes in the error list.
List of error objects
[
{
"timestamp": 0,
"errorCode": 0,
"message": "",
"state": true
}
]
Available only on servers:
Accepts the following message:
An event describing the device information for a car position unit connected to the bus.
A virtual device info object containing the manufacturer, the device name, the firmware version string, and the CiA ID.
{
"manufacturerId": 0,
"manufacturer": "string",
"deviceName": "string",
"firmware": "string",
"protocol": "string",
"nodeId": 0
}
Available only on servers:
Accepts the following message:
An event describing the change of position of the car in shaft in mm.
position in mm
Available only on servers:
Accepts the following message:
An event describing the change of the car drive unit's properties connected via node ID.
A virtual device info object containing the manufacturer, the device name, the firmware version string, and the CiA ID.
{
"manufacturerId": 0,
"manufacturer": "string",
"deviceName": "string",
"firmware": "string",
"protocol": "string",
"nodeId": 0
}
Available only on servers:
Accepts the following message:
An event describing the change of the status word.
The raw value bits of the status word. For the definition of the bits, see CIA 402_2 object 6041 h.
Available only on servers:
Accepts the following message:
An event describing the change of the control word.
The raw value bits of the control word. For the definition of the bits, see CIA 402_2 object 6040 h and CIA 417_4 object 6400 h.
Available only on servers:
Accepts the following message:
An event describing the mode of operation the car drive unit is actually employing. This value is in object 6404h.
Drive unit mode of operation
UNKNOWN
Available only on servers:
Accepts the following message:
An event describing the mode of operation the controller requested for the car drive unit. This value is in object 6403h.
Drive unit mode of operation
UNKNOWN
Available only on servers:
Accepts the following message:
An event describing the current velocity the car drive unit is establishing. It is the value published in object 6433h.
The velocity in mm/s.
Available only on servers:
Accepts the following message:
An event describing the velocity requested by the controller from the car drive unit. It is the value published in object 6430h.
The requested velocity in mm/s.
Available only on servers:
Accepts the following message:
An event describing the position requested by the controller from the car drive unit. It is the value published in object 6420h.
The requested position in mm.
Available only on servers:
Accepts the following message:
An event describing the change of the car door unit's properties connected via node ID. The unitId is equal to the door id.
A virtual device info object containing the manufacturer, the device name, the firmware version string, and the CiA ID.
{
"manufacturerId": 0,
"manufacturer": "string",
"deviceName": "string",
"firmware": "string",
"protocol": "string",
"nodeId": 0
}
Available only on servers:
Accepts the following message:
An event describing the change of position of the car in shaft in mm. The unitId is equal to the door id.
position in mm
Available only on servers:
Accepts the following message:
An event describing the change of the car door unit's status word.
The raw value bits of the status word. For the definition of the bits, see CIA 402_2 object 6041 h.
Available only on servers:
Accepts the following message:
An event describing the change of the car door unit's control word.
The raw value bits of the control word. For the definition of the bits, see CIA 402_2 object 6040 h and CIA 417_4 object 6400 h.
Available only on servers:
Accepts the following message:
An event describing the device information for a load measuring unit connected to the bus.
A virtual device info object containing the manufacturer, the device name, the firmware version string, and the CiA ID.
{
"manufacturerId": 0,
"manufacturer": "string",
"deviceName": "string",
"firmware": "string",
"protocol": "string",
"nodeId": 0
}
Available only on servers:
Accepts the following message:
An event describing the total load measured by load measuring unit.
The total load in kilograms reported by the load measuring unit.
Available only on servers:
Accepts the following message:
An event describing the current load signaling, i.e. if the load measuring unit detects e.g. weight inside of norm values, overload, or full capacity.
A string describing the load signaling.
NORM
Available only on servers:
Accepts the following message:
An event describing the load measured by load measuring unit on this particular rope, given it is a rope elevator.
The load in kilograms reported by the load measuring unit for the respective rope.
Available only on servers:
Accepts the following message:
An event describing the device information for a light barrier unit connected to the bus. The unitId is equivalent to the door number to which the light barrier unit is installed.
A virtual device info object containing the manufacturer, the device name, the firmware version string, and the CiA ID.
{
"manufacturerId": 0,
"manufacturer": "string",
"deviceName": "string",
"firmware": "string",
"protocol": "string",
"nodeId": 0
}
Available only on servers:
Accepts the following message:
An event describing the state of a light barrier unit, i.e. if the light barrier is interrupted (active) or uninterrupted (inactive).
A string describing binary interface state.
INACTIVE
Available only on servers:
Accepts the following message:
An event describing the device information for a sub-device connected to the bus via another device. The unitId is unique on the bus.
A CliIoUnit info object containing the cli-io-unit id, the version, and its name.
{
"manufacturerId": 0,
"manufacturer": "string",
"deviceName": "string",
"firmware": "string",
"protocol": "string",
"nodeId": 0,
"cliIoUnitId": 0,
"cliIoUnitName": "string",
"cliIoUnitVersion": "string"
}
Available only on servers:
Accepts the following message:
An event describing the state of the cli unit.
device is active/inactive
Available only on servers:
Accepts the following message:
An event showing the configuration with name {pluginConfigName} for an installed plugin brobeilmodbus.
An object which contains the configuration of a brobeil modbus plugin
{
"enabled": true,
"modbusTcp": {
"ipv4Address": "string",
"port": 0
},
"positionSensor": {
"enabled": true,
"resolution": 0
},
"carDriveUnit": {
"enabled": true
},
"canOpenNodeConfigurations": [
{
"filter": {
"vendorId": "1125",
"profileNumber": "417",
"nodeId": "7",
"manufacturerDeviceName": "iCon",
"manufacturerSoftwareVersion": "1.0",
"canBusName": "hwcan0"
},
"entries": [
{
"index": 0,
"subIndex": 0,
"variantName": "U8t",
"value": 0
}
]
}
]
}
Available only on servers:
Accepts the following message:
An event describing the change of the position supervisor unit's properties connected via node ID.
A virtual device info object containing the manufacturer, the device name, the firmware version string, and the CiA ID.
{
"manufacturerId": 0,
"manufacturer": "string",
"deviceName": "string",
"firmware": "string",
"protocol": "string",
"nodeId": 0
}
Available only on servers:
Accepts the following message:
An event describing the change of the status.
The raw value bits of the PSU status. For the definition of the bits, see CIA 417_4 object 63E1 h subindex 1 h.
Available only on servers:
Accepts the following message:
An event describing the supported features of the PSU.
The raw value bits of the feature word. For the definition of the bits, see CIA 417_4 object 63E1 h subindex 2 h.
Available only on servers:
Accepts the following message:
An event describing the change of the control word.
The raw value bits of the control word. For the definition of the bits, see CIA 417_4 object 63E0 h.
Available only on servers:
Accepts the following message:
An event allowing to set the configuration with name {pluginConfigName} for a potentially installed plugin brobeilmodbus.
An object which contains the configuration of a brobeil modbus plugin
{
"enabled": true,
"modbusTcp": {
"ipv4Address": "string",
"port": 0
},
"positionSensor": {
"enabled": true,
"resolution": 0
},
"carDriveUnit": {
"enabled": true
},
"canOpenNodeConfigurations": [
{
"filter": {
"vendorId": "1125",
"profileNumber": "417",
"nodeId": "7",
"manufacturerDeviceName": "iCon",
"manufacturerSoftwareVersion": "1.0",
"canBusName": "hwcan0"
},
"entries": [
{
"index": 0,
"subIndex": 0,
"variantName": "U8t",
"value": 0
}
]
}
]
}
Available only on servers:
Accepts the following message:
An event triggering the initialsation of the virtual terminal.
An info object describing the terminal dimensions in column and row units.
{
"rows": 0,
"columns": 0
}
Available only on servers:
Accepts the following message:
An event triggering the termination of the virtual terminal.
Available only on servers:
Accepts the following message:
An event sending a control input to the virtual terminal.
Input characters for virtual terminal.
END
Available only on servers:
Accepts the following message:
An event sending the content of the virtual terminal.
Input characters for virtual terminal.
[
[
"string"
]
]
Available only on servers:
Accepts the following message:
An event sending the location of the cursor on the virtual terminal. Sending an empty message disables the cursor.
An info object holding the location of the cursors.
{
"row": 0,
"column": 0
}
An info object describing a device (virtual or actual) containing the manufacturer, the device name, the firmware version string, and the CiA ID.
A node description object containing the manufacturer, the device name, the firmware version string, and the CiA ID.
A virtual device info object containing the manufacturer, the device name, the firmware version string, and the CiA ID.
A CliIoUnit info object containing the cli-io-unit id, the version, and its name.
An object describing a device to be of a predefined category and a unique ID among other devices in the same device category.
An object which contains the configuration of a brobeil modbus plugin
The device category of the device stored in objects 1000h and 6000h respectively.
An object describing the current ethernet configuration of the given interface.
An object describing the readonly ethernet configuration parts of the given interface.
An object describing the current modbus tcp configuration.
An object describing the current position sensor configuration.
An object describing the config for a car drive unit.
An object describing the current ethernet configuration of the given interface.
An IPv4 formated IP address
An interface name.
A can interface name.
An arbitrary string describing the plugin configuration. Currently only 'default' is supported.
A ethernet interface name.
An integer depicting the node ID of the can node.
An integer describing the device uniquely inside of a category of devices. It is possible that more than one device of the same category, e.g. position sensors, exist in the elevator. This ID distinguishes between different devices.
An integer describing the device uniquely inside of the scope of the device it is connected to. The id can exist on more than one cli-io-unit given it is connected to another device.
An integer describing the respective rope holding the elevator car.
A string describing the load signaling.
A string describing the interface type.
A string describing binary interface state.
The raw value bits of the status word. For the definition of the bits, see CIA 402_2 object 6041 h.
The raw value bits of the control word. For the definition of the bits, see CIA 402_2 object 6040 h and CIA 417_4 object 6400 h.
Drive unit mode of operation
An configuration consisting of filter and entries to write object dictionary of CANopen nodes.
An entry to write to an object dictionary of CANopen nodes.
An entry to write to an object dictionary of CANopen nodes.
An info object describing the terminal dimensions in column and row units.
Input characters for virtual terminal.
Input characters for virtual terminal.
Array of characters representing a row in a terminal.
An info object holding the location of the cursors.
An info object holding the location of the cursors.