|
BAOS .net SDK
18.2.0
|
BaosServerItems is used to get/set the server item parameters from/on the remote device. More...
#include <BaosServerItems.h>
Public Types | |
| enum | Baudrate { Baudrate::Unknown = unmanaged::BaosServerItems::Unknown, Baudrate::B19200 = unmanaged::BaosServerItems::B19200, Baudrate::B115200 = unmanaged::BaosServerItems::B115200 } |
| Possible values for server item Baudrate, id 13 More... | |
| enum | ProgrammingMode { ProgrammingMode::NotActive = unmanaged::BaosServerItems::NotActive, ProgrammingMode::Active = unmanaged::BaosServerItems::Active } |
| Possible values for server item ProgrammingMode, id 15 More... | |
| enum | IndicationSetting { IndicationSetting::IndicationSetting_NotActive = unmanaged::BaosServerItems::IndicationSetting_NotActive, IndicationSetting::IndicationSetting_Active = unmanaged::BaosServerItems::IndicationSetting_Active } |
| Possible values for server item Indication Sending, id 17 More... | |
Public Member Functions | |
| BaosServerItems (Connector^connector) | |
| Creates a BaosServerItems object with a specified connector More... | |
| ~BaosServerItems () | |
| Destroys the BaosServerItems. More... | |
| array< unsigned char > | getHardwareType () |
| Gets the hardware type. More... | |
| unsigned char | getHardwareVersion () |
| Gets the version of the ObjectServer hardware More... | |
| unsigned char | getFirmwareVersion () |
| Gets the version of ObjectServer firmware. More... | |
| unsigned int | getManufactureCodeDevice () |
| Gets the KNX manufacturer code of the device. More... | |
| unsigned int | getManufactureCodeApp () |
| Gets the KNX manufacturer code loaded by ETS. More... | |
| unsigned int | getApplicationId () |
| Gets the id of application loaded by ETS. More... | |
| unsigned char | getApplicationVersion () |
| Gets the version of application loaded by ETS. More... | |
| array< unsigned char > | getSerialNumber () |
| Gets KNX serial number of device. More... | |
| unsigned long | getTimeSinceReset () |
| Gets the time since reset in ms. More... | |
| bool | isBusConnected () |
| Returns true if the KNX bus is connected, otherwise false. More... | |
| unsigned int | getMaxBufferSize () |
| Gets the maximal buffer size. More... | |
| unsigned int | getLengthOfDescriptionString () |
| Gets the length of the description string. More... | |
| void | setBaudrate (unsigned char baudrate) |
| Sets the Baudrate More... | |
| unsigned char | getBaudrate () |
| Gets the baudrate. More... | |
| void | setBufferSize (unsigned int bufferSize) |
| Sets the current buffer size. More... | |
| unsigned int | getBufferSize () |
| Gets the current buffer size. More... | |
| void | setProgrammingMode (unsigned char programmingMode) |
| Sets the programming mode More... | |
| unsigned char | getProgrammingMode () |
| Gets the programming mode. More... | |
| unsigned char | getBinaryProtocolVersion () |
| Gets the version of the ObjectServer binary protocol More... | |
| void | setIndicationSetting (unsigned char indicationSetting) |
| Sets the indication setting More... | |
| unsigned char | getIndicationSetting () |
| Gets the indication setting More... | |
| unsigned char | getWebServicesProtocolVersion () |
| Gets the version of the ObjectServer web services protocol More... | |
Protected Member Functions | |
| !BaosServerItems () | |
| Finalizer (non-deterministic destructor) cleans up unmanaged resources. More... | |
BaosServerItems is used to get/set the server item parameters from/on the remote device.
It wraps the GetServerItem and SetServerItem services, which are byte based and provides the appropriate interpretation to convert the parameters to their corresponding values.
| kdrive::baos::bindings::BaosServerItems::BaosServerItems | ( | Connector^ | connector | ) |
Creates a BaosServerItems object with a specified connector
| kdrive::baos::bindings::BaosServerItems::~BaosServerItems | ( | ) |
Destroys the BaosServerItems.
Destructor cleans up unmanaged and managed resources.
|
protected |
Finalizer (non-deterministic destructor) cleans up unmanaged resources.
| unsigned int kdrive::baos::bindings::BaosServerItems::getApplicationId | ( | ) |
Gets the id of application loaded by ETS.
It is mapped to bytes 2 and 3 of property
PID_APPLICATION_VER in the application object.
Server item: application id (ETS), id 6
| unsigned char kdrive::baos::bindings::BaosServerItems::getApplicationVersion | ( | ) |
Gets the version of application loaded by ETS.
It is mapped to byte 4 of property PID_APPLICATION_VER in application object.
Server item: application version (ETS), id 7
| unsigned char kdrive::baos::bindings::BaosServerItems::getBaudrate | ( | ) |
| unsigned char kdrive::baos::bindings::BaosServerItems::getBinaryProtocolVersion | ( | ) |
Gets the version of the ObjectServer binary protocol
Server item: Protocol Version (Binary), id 16
| unsigned int kdrive::baos::bindings::BaosServerItems::getBufferSize | ( | ) |
Gets the current buffer size.
Server item: Current buffer size, id 14
| unsigned char kdrive::baos::bindings::BaosServerItems::getFirmwareVersion | ( | ) |
Gets the version of ObjectServer firmware.
Coding Ex.: 0x10 = Version 1.0
Server item: firmware version, id 3
| array<unsigned char> kdrive::baos::bindings::BaosServerItems::getHardwareType | ( | ) |
Gets the hardware type.
Can be used to identify the hardware type.
It is mapped to property PID_HARDWARE_TYPE in the device object.
Server item: hardware type, id 1
| unsigned char kdrive::baos::bindings::BaosServerItems::getHardwareVersion | ( | ) |
Gets the version of the ObjectServer hardware
Coding Ex.: 0x10 = Version 1.0
Server item: hardware version, id 2
| unsigned char kdrive::baos::bindings::BaosServerItems::getIndicationSetting | ( | ) |
Gets the indication setting
Server item: Indication Sending, id 17
| unsigned int kdrive::baos::bindings::BaosServerItems::getLengthOfDescriptionString | ( | ) |
Gets the length of the description string.
Server item: Length of description string, id 12
| unsigned int kdrive::baos::bindings::BaosServerItems::getManufactureCodeApp | ( | ) |
Gets the KNX manufacturer code loaded by ETS.
It is mapped to bytes 0 and 1 of property
PID_APPLICATION_VER in the application object.
Server item: KNX manufacture code APP, id 5
| unsigned int kdrive::baos::bindings::BaosServerItems::getManufactureCodeDevice | ( | ) |
Gets the KNX manufacturer code of the device.
Not modified by ETS.
It is mapped to property PID_MANUFACTURER_ID in the device object.
Server item: KNX manufacture code DEV, id 4
| unsigned int kdrive::baos::bindings::BaosServerItems::getMaxBufferSize | ( | ) |
Gets the maximal buffer size.
Server item: Maximal buffer size, id 11
| unsigned char kdrive::baos::bindings::BaosServerItems::getProgrammingMode | ( | ) |
| array<unsigned char> kdrive::baos::bindings::BaosServerItems::getSerialNumber | ( | ) |
Gets KNX serial number of device.
It is mapped to property PID_SERIAL_NUMBER in the device object.
Server item: serial number, id 8
| unsigned long kdrive::baos::bindings::BaosServerItems::getTimeSinceReset | ( | ) |
Gets the time since reset in ms.
Server item: time since reset, id 9
| unsigned char kdrive::baos::bindings::BaosServerItems::getWebServicesProtocolVersion | ( | ) |
Gets the version of the ObjectServer web services protocol
Server item: Protocol Version (WebService), id 18
| bool kdrive::baos::bindings::BaosServerItems::isBusConnected | ( | ) |
Returns true if the KNX bus is connected, otherwise false.
Server item: bus connection state, id 10
| void kdrive::baos::bindings::BaosServerItems::setBaudrate | ( | unsigned char | baudrate | ) |
Sets the Baudrate
Values: BaosServerItems::Unknown, BaosServerItems::BB19200, BaosServerItems::B115200
| void kdrive::baos::bindings::BaosServerItems::setBufferSize | ( | unsigned int | bufferSize | ) |
Sets the current buffer size.
Server item: Current buffer size, id 14
| void kdrive::baos::bindings::BaosServerItems::setIndicationSetting | ( | unsigned char | indicationSetting | ) |
Sets the indication setting
Values: IndicationSetting::IndicationSetting_NotActive IndicationSetting::IndicationSetting_Active
Server item: Indication Sending, id 17
| void kdrive::baos::bindings::BaosServerItems::setProgrammingMode | ( | unsigned char | programmingMode | ) |
Sets the programming mode
Values: ProgrammingMode::NotActive ProgrammingMode::Active
Server item: Programming mode, id 15
1.8.11
