BaosDeviceDataTypes.h

Go to the documentation of this file.

//
// Copyright (c) 2002-2026 WEINZIERL ENGINEERING GmbH
// All rights reserved.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY,
// WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE
//
 
#ifndef __BAOSLIB_INTERFACE_DATA_TYPES_H__
#define __BAOSLIB_INTERFACE_DATA_TYPES_H__
 
#include "baos/config.h"
 
#include "baos/connection/BaosConnection.h"
#include "baos/device/BaosDevicesMeta.h"
#include "baos/protocol/Defines.h"
 
#include "BlockReader.h"
 
#include "wzcpp/features/algorithm/append.h"
#include "wzcpp/features/utils/ByteArray.h"
#include "wzcpp/features/utils/Memory.h"
 
#include <memory>
#include <optional>
#include <utility>
 
namespace wz::baos
{
 
struct BAOSLIB_EXPORT DeviceStaticInfo
{
    wzcpp::SixByteArray hardwareType{0x0, 0x0, 0x0, 0x0, 0x0, 0x0};  
    std::uint8_t hardwareVersion{0};                                 
    std::uint8_t firmwareVersion{0};                                 
    std::uint16_t manufactureCodeDevice{0};                          
    wzcpp::SixByteArray serialNumber{0x0, 0x0, 0x0, 0x0, 0x0, 0x0};  
    std::uint16_t maxBufferSize{0};              
    std::uint8_t binaryProtocolVersion{0};       
    std::uint8_t webServicesProtocolVersion{0};  
    std::uint8_t restServiceProtocolVersion{0};  
    wzcpp::SixByteArray macAddress{0x0, 0x0, 0x0, 0x0, 0x0, 0x0};  
    std::uint8_t maxManagementClients{0};                          
    std::uint8_t maxTunnellingClients{0};  
    std::uint8_t maxBaosUdpClients{0};     
    std::uint8_t maxBaosTcpClients{0};     
    std::uint16_t maxDatapoints{0};        
    std::uint16_t maxParameterBytes{0};    
 
    static constexpr std::array ids{
        protocol::ServerItemId::HardwareType,
        protocol::ServerItemId::HardwareVersion,
        protocol::ServerItemId::ManufactureCodeDevice,
        protocol::ServerItemId::SerialNumber,
        protocol::ServerItemId::MaxBufferSize,
        protocol::ServerItemId::BinaryProtocolVersion,
        protocol::ServerItemId::WebServicesProtocolVersion,
        protocol::ServerItemId::RestServiceProtocolVersion,
        protocol::ServerItemId::MacAddress,
        protocol::ServerItemId::MaxManagementClients,
        protocol::ServerItemId::MaxTunnellingClients,
        protocol::ServerItemId::MaxBaosUdpClients,
        protocol::ServerItemId::MaxBaosTcpClients,
        protocol::ServerItemId::MaxDatapoints,
        protocol::ServerItemId::MaxParameterBytes};  
};
 
 
struct BAOSLIB_EXPORT DeviceConfigInfo
{
    std::uint16_t manufactureCodeApp{0};  
    std::uint16_t applicationId{0};      
    std::uint8_t applicationVersion{0};  
    std::uint16_t lengthOfDescriptionString{0};  
    std::uint8_t baudrateItem{0};                
    std::uint16_t currentBufferSize{0};          
    bool indicationSetting{
        false};  
    std::uint16_t individualAddress{0};  
    bool tunnellingEnabled{false};       
    bool baosBinaryEnabled{false};       
    bool baosWebEnabled{false};          
    bool baosRestEnabled{false};         
    bool httpFileEnabled{false};         
    bool searchRequestEnabled{false};    
    bool isStructured{false};  
    std::uint16_t configuredDatapoints{0};  
    std::string deviceFriendlyName;         
    std::uint16_t downloadCounter{0};       
    protocol::IpAssigmentMethod iPAssignment{
        protocol::IpAssigmentMethod::dhcp};  
    std::array<std::uint8_t, 4> iPAddress;   
    std::array<std::uint8_t, 4> subnetMask;  
    std::array<std::uint8_t, 4>
        defaultGateway;  
    protocol::TimeSinceResetUnit timeSinceResetUnit;  
    std::int8_t SystemTimezoneOffset{0};              
    bool menuEnabled{false};  
    bool suspendEnabled{
        false};  
    wzcpp::SixByteArray rfDomainAddress{
        0x0, 0x0, 0x0, 0x0, 0x0, 0x0};  
    protocol::StatusFlagsSupported statusFlagsSupported{
        0x0000};  
    static constexpr std::array ids{
        protocol::ServerItemId::ManufactureCodeApp,
        protocol::ServerItemId::ApplicationId,
        protocol::ServerItemId::ApplicationVersion,
        protocol::ServerItemId::LengthOfDescriptionString,
        protocol::ServerItemId::BaudrateItem,
        protocol::ServerItemId::CurrentBufferSize,
        protocol::ServerItemId::IndicationSetting,
        protocol::ServerItemId::IndividualAddress,
        protocol::ServerItemId::TunnellingEnabled,
        protocol::ServerItemId::BaosBinaryEnabled,
        protocol::ServerItemId::BaosWebEnabled,
        protocol::ServerItemId::BaosRestEnabled,
        protocol::ServerItemId::HttpFileEnabled,
        protocol::ServerItemId::SearchRequestEnabled,
        protocol::ServerItemId::IsStructured,
        protocol::ServerItemId::DeviceFriendlyName,
        protocol::ServerItemId::ConfiguredDatapoints,
        protocol::ServerItemId::DownloadCounter,
        protocol::ServerItemId::IPAssignment,
        protocol::ServerItemId::IPAddress,
        protocol::ServerItemId::SubnetMask,
        protocol::ServerItemId::DefaultGateway,
        protocol::ServerItemId::TimeSinceResetUnit,
        protocol::ServerItemId::SystemTimezoneOffset,
        protocol::ServerItemId::MenuEnabled,
        protocol::ServerItemId::SuspendEnabled,
        protocol::ServerItemId::RFDomainAddress,
        protocol::ServerItemId::StatusFlagsSupported};  
};
 
 
struct BAOSLIB_EXPORT DeviceRuntimeInfo
{
    std::uint32_t timeSinceReset{0};             
    bool busConnected{false};                    
    bool programmingMode{false};                 
    std::uint8_t connectedManagementClients{0};  
    std::uint8_t connectedTunnellingClients{0};  
    std::uint8_t connectedBaosUdpClients{0};     
    std::uint8_t connectedBaosTcpClients{0};     
    Buffer SystemTime;                           
    protocol::StatusFlags statusFlags{
        0x0000};  
    static constexpr std::array ids{
        protocol::ServerItemId::TimeSinceReset,
        protocol::ServerItemId::BusConnected,
        protocol::ServerItemId::ProgrammingMode,
        protocol::ServerItemId::ConnectedManagementClients,
        protocol::ServerItemId::ConnectedTunnellingClients,
        protocol::ServerItemId::ConnectedBaosUdpClients,
        protocol::ServerItemId::ConnectedBaosTcpClients,
        protocol::ServerItemId::SystemTime,
        protocol::ServerItemId::StatusFlags};  
};
 
struct BAOSLIB_EXPORT DatapointConfig
{
    protocol::DatapointSize size;         
    protocol::DatapointConfigFlags flags; 
    protocol::DPT dpt;                    
    std::string desc;                     
};
 
std::string BAOSLIB_EXPORT toString(const DatapointConfig& config);  
 
 
using DatapointConfigurations = std::map<std::uint16_t, DatapointConfig>;  
 
enum class ServerItemReadStrategy : std::uint8_t
{
    METADATAREAD,  
    METADATAREADWITHFALLBACK,  
    ALLATONCE                  
};
 
struct DeviceClassConfig
{
    bool cacheEnabled;                      
    bool blockReadEnabled;                  
    ServerItemReadStrategy siReadStrategy;  
};
 
}  // namespace wz::baos
 
#endif  // __BAOSLIB_INTERFACE_DATA_TYPES_H__