BAOS SDK v2
1.0.1
An SDK providing access to IP-BAOS devices through BAOS binary protocol version 2.x
|
A collection of fields representing those serveritems which may change if the configuration of the device is changed. More...
#include <baos/device/BaosDeviceDataTypes.h>
Public Attributes | |
std::uint16_t | manufactureCodeApp {0} |
The manufacturer code of the ETS application e.g. 0x00C5 for Weinzierl. | |
std::uint16_t | applicationId {0} |
std::uint8_t | applicationVersion {0} |
std::uint16_t | lengthOfDescriptionString {0} |
The maximum length of a datapoint description string. | |
std::uint8_t | baudrateItem {0} |
The current BAUD rate. Only useful for serial FT1.2 connections. | |
std::uint16_t | currentBufferSize {0} |
The current maximum length for a BAOS telegram. | |
bool | indicationSetting |
Is sending of indication via the BAOS binary protocol enabled(true) or disabled(false) More... | |
std::uint16_t | individualAddress {0} |
The KNX individual address. | |
bool | tunnellingEnabled {false} |
Is the KNXnet/IP tunneling server enabled(true) or disabled(false) | |
bool | baosBinaryEnabled {false} |
Is the BAOS binary protocol enabled, This SDK relies on this to be true. | |
bool | baosWebEnabled {false} |
Are the BAOS webservices on the device enabled(true) or disabled(false) | |
bool | baosRestEnabled {false} |
Are the BAOS REST services on the device enabled(true) or disabled(false) | |
bool | httpFileEnabled {false} |
Is the webserver on the device enabled(true) or disabled(false) | |
bool | searchRequestEnabled {false} |
Does the device react to a KNXnet/IP Search request(true) or not (false) | |
bool | isStructured {false} |
std::uint16_t | configuredDatapoints {0} |
How many datapoints are configured in the device. | |
std::string | deviceFriendlyName |
For IP devices the same as KNXnet/IP device friendly name. | |
std::uint16_t | downloadCounter {0} |
The ETS download counter. | |
protocol::IpAssigmentMethod | iPAssignment |
std::array< std::uint8_t, 4 > | iPAddress |
std::array< std::uint8_t, 4 > | subnetMask |
If manual IP assignment is selected, this is the subnet mask to set. | |
std::array< std::uint8_t, 4 > | defaultGateway |
If manual IP assigment is selected, this is the default gateway to be set in the device. | |
protocol::TimeSinceResetUnit | timeSinceResetUnit |
The unit in which timesincereset is represented. | |
std::int8_t | SystemTimezoneOffset {0} |
The offset in hours of the system time to UTC. | |
bool | menuEnabled {false} |
bool | suspendEnabled |
Is the suspend on idle mode ativated or not. Only usefull for USB devices at the moment. More... | |
wzcpp::SixByteArray | rfDomainAddress |
The RF domain address. Only for device supported KNX RF as medium. More... | |
protocol::StatusFlagsSupported | statusFlagsSupported |
A collection of flags with current device state and capabilities. More... | |
Static Public Attributes | |
static constexpr std::array | ids |
A std::array with all the serveritem ids in this collection. More... | |
A collection of fields representing those serveritems which may change if the configuration of the device is changed.
Things like the individual address, the ip addres etc. may be changed during an ETS download or a configuration change by other means. But during the day to day operation of the device those are not changed.
std::uint16_t applicationId {0} |
ID of application loaded by ETS. It is mapped to bytes 2 and 3 of property PID_APPLICATION_VER in application object.
std::uint8_t applicationVersion {0} |
Version of application loaded by ETS. It is mapped to byte 4 of property PID_APPLICATION_VER in application object.
bool indicationSetting |
Is sending of indication via the BAOS binary protocol enabled(true) or disabled(false)
bool isStructured {false} |
Some devices like the 777 may contain additional data about the building structure, like rooms etc.
protocol::IpAssigmentMethod iPAssignment |
How the devices assigns its own IP address, In most cases the manual and dhco version are the viable options.
std::array<std::uint8_t, 4> iPAddress |
If manual IP assignment is selected, this is the ip address that the device should use for itself.
bool menuEnabled {false} |
Are configuration changes via the device menu, visible on the display of the device itself allowed or not
bool suspendEnabled |
Is the suspend on idle mode ativated or not. Only usefull for USB devices at the moment.
wzcpp::SixByteArray rfDomainAddress |
The RF domain address. Only for device supported KNX RF as medium.
protocol::StatusFlagsSupported statusFlagsSupported |
A collection of flags with current device state and capabilities.
|
staticconstexpr |
A std::array with all the serveritem ids in this collection.