Raritan PX2/PX3 JSON-RPC API: pdu-json-rpc-api/idl/ModbusDevice.idl Source File

Raritan PX2/PX3 JSON-RPC API

ModbusDevice.idl
1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /*
3 * Copyright 2012 Raritan Inc. All rights reserved.
4 */
5
6 #ifndef __MODBUS_IDL__
7 #define __MODBUS_IDL__
8
9 module modbus {
10 interface Device {
11 /** modbus encapsulated transport device identification (0x2B / 0x0E) */
12 structure DeviceID {
13 string vendor; ///< the vendor name (0x00)
14 string code; ///< the product code (0x01)
15 string version; ///< the major minor revision (0x02)
16 string url; ///< the vendor URL (0x03) (optional)
17 string name; ///< the product name (0x04) (optional)
18 string model; ///< the model name (0x05) (optional)
19 string app; ///< the user application name (0x06) (optional)
20 // type of optional proprietary objects (0x80 - 0xFF) are not known
21 // needs to be defined by proprietary DeviceID if required
22 };
23
24 /**
25 * Read the modbus encapsulated transport device identification (0x2B / 0x0E).
26 *
27 * @return device identification.
28 */
29 DeviceID readDeviceIdentification();
30 };
31 }
32
33 #endif /* __MODBUS_IDL__ */
modbus::Device::DeviceID::app
string app
the user application name (0x06) (optional)
Definition: ModbusDevice.idl:19
modbus::Device::DeviceID::model
string model
the model name (0x05) (optional)
Definition: ModbusDevice.idl:18
modbus
Definition: ModbusDevice.idl:9
modbus::Device::DeviceID
modbus encapsulated transport device identification (0x2B / 0x0E)
Definition: ModbusDevice.idl:12
modbus::Device::DeviceID::name
string name
the product name (0x04) (optional)
Definition: ModbusDevice.idl:17
modbus::Device
Definition: ModbusDevice.idl:10
modbus::Device::DeviceID::vendor
string vendor
the vendor name (0x00)
Definition: ModbusDevice.idl:13
modbus::Device::DeviceID::version
string version
the major minor revision (0x02)
Definition: ModbusDevice.idl:15
modbus::Device::DeviceID::url
string url
the vendor URL (0x03) (optional)
Definition: ModbusDevice.idl:16
modbus::Device::DeviceID::code
string code
the product code (0x01)
Definition: ModbusDevice.idl:14