BAOS SDK v2  1.0.1
An SDK providing access to IP-BAOS devices through BAOS binary protocol version 2.x
DeviceConfigInfo Struct Reference

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...
 

Detailed Description

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.

Member Data Documentation

◆ applicationId

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.

◆ applicationVersion

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.

◆ indicationSetting

bool indicationSetting
Initial value:
{
false}

Is sending of indication via the BAOS binary protocol enabled(true) or disabled(false)

◆ isStructured

bool isStructured {false}

Some devices like the 777 may contain additional data about the building structure, like rooms etc.

◆ iPAssignment

Initial value:
{
@ dhcp
The ip address is requested from a DHCP server.

How the devices assigns its own IP address, In most cases the manual and dhco version are the viable options.

◆ iPAddress

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.

◆ menuEnabled

bool menuEnabled {false}

Are configuration changes via the device menu, visible on the display of the device itself allowed or not

◆ suspendEnabled

bool suspendEnabled
Initial value:
{
false}

Is the suspend on idle mode ativated or not. Only usefull for USB devices at the moment.

◆ rfDomainAddress

wzcpp::SixByteArray rfDomainAddress
Initial value:
{
0x0, 0x0, 0x0, 0x0, 0x0, 0x0}

The RF domain address. Only for device supported KNX RF as medium.

◆ statusFlagsSupported

protocol::StatusFlagsSupported statusFlagsSupported
Initial value:
{
0x0000}

A collection of flags with current device state and capabilities.

◆ ids

constexpr std::array ids
staticconstexpr
Initial value:
{
@ SearchRequestEnabled
(Read / Write; 1 byte; from V2.1)
@ MenuEnabled
(Read / Write; 1 byte; from V2.1)
@ DownloadCounter
(Read Only; 2 bytes; from V2.1)
@ TimeSinceResetUnit
(Read / Write; 1 byte; from V2.1)
@ LengthOfDescriptionString
(Read Only; 2 bytes)
@ RFDomainAddress
(Read / Write; 6 bytes;)
@ IsStructured
(Read Only; 1 byte; from V2.1)
@ SystemTimezoneOffset
(Read / Write; 1 byte (signed); from V2.1)
@ TunnellingEnabled
(Read / Write; 1 byte; from V2.1)
@ ApplicationVersion
(Read Only; 1 bytes)
@ IndicationSetting
Indicates whether indications are sent (Read/Write; 1 byte; from V2.0)
@ IPAddress
(Read / Write; 4 bytes; from V2.1)
@ BaudrateItem
(Read/Write; 1 byte)
@ ManufactureCodeApp
(Read Only; 2 bytes)
@ DeviceFriendlyName
(Read / Write; 30 bytes; from V2.1)
@ BaosWebEnabled
(Read / Write; 1 byte; from V2.1)
@ ConfiguredDatapoints
(Read Only; 2 bytes; from V2.1)
@ ApplicationId
(Read Only; 2 bytes)
@ SubnetMask
(Read / Write; 4 bytes; from V2.1)
@ DefaultGateway
(Read / Write; 4 bytes; from V2.1)
@ BaosRestEnabled
(Read / Write; 1 byte; from V2.1)
@ IndividualAddress
(Read / Write; 2 byte; from V2.1)
@ SuspendEnabled
(Read / Write; 1 byte; from 2.1)
@ IPAssignment
(Read / Write; 1 byte; from V2.1)
@ HttpFileEnabled
(Read / Write; 1 byte; from V2.1)
@ CurrentBufferSize
(Read Only; 2 bytes)
@ BaosBinaryEnabled
(Read / Write; 1 byte; from V2.1)
@ StatusFlagsSupported
(Read Only; 2 bytes; from V2.1)

A std::array with all the serveritem ids in this collection.


The documentation for this struct was generated from the following file: