#include <atomic>
#include <bit>
#include <cstdint>
#include <cstring>
#include <expected>
#include <format>
#include <nlohmann/json_fwd.hpp>
#include <optional>
#include <span>
#include <string>
#include <string_view>
#include <type_traits>
#include <variant>
#include <vector>

Include dependency graph for device_parameter.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	mm::node::ObjectAddress< T >
	The address of one object-dictionary entry, carrying the type that entry holds. More...

struct	mm::node::ScalarCell
	One scalar value, and the only part of a `DeviceParameter` that two threads touch at once. More...

struct	mm::node::DeviceParameter
	A single object dictionary entry held by a `Device`. More...

Namespaces
namespace	mm

namespace	mm::node

Typedefs
using	mm::node::DeviceParameterValue = std::variant< int8_t, int16_t, int32_t, int64_t, uint8_t, uint16_t, uint32_t, uint64_t, float, double, std::string, std::vector< uint8_t > >
	Decoded value of a single device parameter (CoE object dictionary entry).

Enumerations
enum class	mm::node::SyncState : uint8_t { mm::node::Unknown , mm::node::Synced , mm::node::Pending }
	Tracks how a cached parameter value relates to the device. More...

enum class	mm::node::ParameterOrigin : uint8_t { mm::node::ObjectDictionary , mm::node::Sii }
	Where a parameter's definition (schema/metadata) came from. More...

Functions
constexpr uint32_t	mm::node::makeParameterKey (uint16_t index, uint8_t subindex)
	Packs an object dictionary `index` and `subindex` into a single 32-bit key.

DeviceParameterValue	mm::node::defaultValueForDataType (uint16_t dataType)
	Returns a zero-equivalent value for the given ETG.1020 `dataType`.

bool	mm::node::isScalarDataType (uint16_t dataType)
	Whether a value of `dataType` is stored in `DeviceParameter::bits`.

size_t	mm::node::scalarByteWidth (uint16_t dataType)
	Width in bytes of a value of `dataType`, or `0` when it is not a scalar.

uint64_t	mm::node::packLeBits (std::span< const uint8_t > bytes)
	Packs up to eight raw little-endian wire bytes into a `uint64_t` (zero-extended).

void	mm::node::unpackLeBits (uint64_t bits, std::span< uint8_t > out)
	Unpacks `bits` into `out`, little-endian. The inverse of `packLeBits`.

std::optional< double >	mm::node::numericValue (const DeviceParameterValue &value)
	Coerces a `DeviceParameterValue` to a `double`, when it holds a number.

std::string_view	mm::node::syncStateName (SyncState state)
	Returns the lowercase string form of `state` (`"unknown"` etc.).

std::string_view	mm::node::parameterOriginName (ParameterOrigin origin)
	Returns the string form of `origin` (`"objectDictionary"` / `"sii"`).

std::expected< DeviceParameterValue, std::string >	mm::node::decodeSdoBytes (uint16_t dataType, std::span< const uint8_t > bytes)
	Decodes a raw SDO byte sequence according to an ETG.1020 data type code.

std::expected< std::vector< uint8_t >, std::string >	mm::node::encodeSdoBytes (uint16_t dataType, const DeviceParameterValue &value)
	Serialises a `DeviceParameterValue` to raw SDO bytes — the inverse of `decodeSdoBytes`.

void	mm::node::to_json (nlohmann::json &j, const DeviceParameter &p)
	Serialises a DeviceParameter to JSON.

Classes

Namespaces

Typedefs

Enumerations

Functions