BAOS SDK v2  1.2.1
An SDK providing access to IP-BAOS devices through BAOS binary protocol version 2.x
Loading...
Searching...
No Matches
GetDatapointValue.cpp

This sample shows how to get datapoint values via the connection API

Datapoint

Usage:

GetDatapointValue <ip_address>
// e.g.:
GetDatapointValue 10.0.0.102

Pre-condition: It assumes that the following datapoints are configured:

|---------|-----------------|-----------------------------|-------------|---------------|
| Number  |  DPT            |  Name                       |  SizeInBit  |  Flags        |
|         |                 |                             |             | C R W T U I   |
|---------|-----------------|-----------------------------|-------------|---------------|
|    1    | DPT 01 - 1 bit  | Actuator A - Switch         | 1           | C - W - - -   |
|---------|-----------------|-----------------------------|-------------|---------------|
|    2    | DPT 01 - 1 bit  | Actuator A - State          | 1           | C R - T - -   |
|---------|-----------------|-----------------------------|-------------|---------------|
|    3    | DPT 01 - 1 bit  | Actuator B - Switch         | 1           | C - W - - -   |
|---------|-----------------|-----------------------------|-------------|---------------|
|    4    | DPT 01 - 1 bit  | Actuator B - State          | 1           | C R - T - -   |
|---------|-----------------|-----------------------------|-------------|---------------|
Note
Another possibility is via the device API.
See also: Sample 04_BaosDatapointValues.cpp
//
// 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
//
#include "Helper.h"
#include <baos/Sdk.h>
#include <wzcpp/features/utils.h>
#include <iostream>
#include <memory>
using namespace wz::baos;
using namespace wz::baos::ip;
using namespace wz::baos::protocol;
/******************************************
** Anonymous namespace
*******************************************/
namespace
{
{
std::cout.fill('0');
std::cout << std::hex << std::uppercase;
for (auto& item : dpValue)
{
std::cout << std::setw(2) << static_cast<std::int32_t>(item) << " ";
}
std::cout << std::nouppercase << std::dec;
}
} // end anonymous namespace
/******************************************
** Main
*******************************************/
int main(int argc, char* argv[])
{
try
{
std::cout << "******************************************" << std::endl;
std::cout << "GetDatapointValue sample" << std::endl;
std::cout << "******************************************" << std::endl;
std::cout << std::endl;
// Reduce log messages
setBaosLogLevel(wz::baos::LogLevel::warn);
// The CommandLineOptions::parse function
// validates the arguments and handles the help command
CommandLineOptions options;
options.parse(argc, argv);
if (options.wasHelpdisplayed())
{
return 0;
}
// Get the ip address from the parsed command line options
const std::string ipAddress = options.getIpAddress();
std::cout << " Connection requested for " << ipAddress << std::endl;
// Create a TPC/IP connection to the remote BAOS device
// Reads some datapoint values (single item per requested)
// id = 2 (DPT 01 - 1 bit)
std::cout << "Reading datapoint value id 2:" << std::endl;
if (valueState.has_value())
{
std::cout << "Id: 2, value: ";
std::cout << std::endl;
}
// id = 4 (DPT 01 - 1 bit)
std::cout << "Reading datapoint value id 4:" << std::endl;
if (valueState.has_value())
{
std::cout << "Id 4, value: ";
std::cout << std::endl;
}
// Reads multiple datapoint values (multiple items per requested)
// Return only the valid datapoints
// id = 1; numbers = 100
std::cout << "Reading datapoint value ids 1 - 100:" << std::endl;
DatapointValueStates valueStates = connection.getDpValues(1, 100, DatapointValueFilter::ALL);
// print datapoint id and it's data buffer as hex string
for (const auto& item : valueStates)
{
const DatapointValueState& value = item.second;
std::cout << "Id: " << item.first;
std::cout << ", value: ";
std::cout << std::endl;
}
}
catch (const std::exception& e)
{
std::cerr << "Failed: " << e.what() << std::endl;
return -1;
}
return 0;
}
Specialization for a TCP IP v4 BAOSConnection.
Global BAOS protocol defines and types.
Global BAOS SDK function and options.
Definition Helper.h:23
protocol::DatapointValueStates getDpValues(std::uint16_t startDpId, std::uint16_t numberOfValues, protocol::DatapointValueFilter filter=protocol::DatapointValueFilter::ALL)
Get a map with the datapoint id as key and the DatapointValueState as value.
std::optional< protocol::DatapointValueState > getDpValue(std::uint16_t dpId)
Get a single datapoint value with its associated state.
A specialization for (connection-less) connection to the BAOS device via a TCP connection.
Definition BaosTcpConnection.h:145
A specialization for (connection oriented) connection to the BAOS device via a TCP connection.
Definition BaosTcpConnection.h:182
void open(const std::string &ip4Address, std::uint16_t port=12004)
Open a connection to physical BAOS device.
Groups BAOS binary protocol specific types , defines and classes for Indications, Responses etc.
Definition Defines.h:33
std::map< std::uint16_t, DatapointValueState > DatapointValueStates
Definition Defines.h:607
wz::baos::Buffer DatapointValue
An type for the DatapointValues.
Definition Defines.h:34
Global BAOS sdk namespace.
Definition config.h:69
BAOSLIB_EXPORT void setBaosLogLevel(wz::baos::LogLevel level)
A combination of the status of a datapoint and its actual value.
Definition Defines.h:601
DatapointValue value
The actual value of the datapoint.
Definition Defines.h:602