Appearance
namespace flake::ParameterProperties
Standard parameter property tags used in protocol messages.
Attributes
| Name | |
|---|---|
| constexpruint32_t | OBJECT_TYPE Type UUID of the object (read-only, UUID). |
| constexpruint32_t | OBJECT_ADDR Object address on the bus (read-only, uint16). |
| constexpruint32_t | BROADCAST_ADDR Broadcast / group address (read-only, uint16). |
| constexpruint32_t | MESSAGE_NAME Name of the custom message (string). |
| constexpruint32_t | CHILDREN_TABLE Serialized table of child objects (binary). |
| constexpruint32_t | COLUMN_SET Set of column tags for table queries (uint16 array). |
| constexpruint32_t | LAST_MODIFICATION_TIME Last modification timestamp (datetime). |
| constexpruint32_t | CREATION_TIME Object creation timestamp (datetime). |
| constexpruint32_t | OBJECT_TABLE Serialized object table (binary). |
| constexpruint32_t | PROP_TAG Property tag value (uint32). |
| constexpruint32_t | PROP_NAME Human-readable property name (string, read-only). |
| constexpruint32_t | PROP_TYPE Property type code (uint16). |
| constexpruint32_t | REQUIRES_AUTH Whether the object requires authentication (bool). |
| constexpruint32_t | STREAM_DATA_STR Stream payload as string. |
| constexpruint32_t | STREAM_DATA_BIN Stream payload as binary blob. |
| constexpruint32_t | STREAM_LEN Stream data length in bytes (uint16). |
| constexpruint32_t | STREAM_POS Current stream position (uint32). |
| constexpruint32_t | STREAM_FLAGS Stream attribute flags (uint8). |
| constexpruint32_t | AUTH_TYPE Authentication type (uint8, read-only). |
| constexpruint32_t | AUTH_USER Authentication user name (string, read-only). |
| constexpruint32_t | AUTH_PASS Authentication password (string, read-only). |
| constexpruint32_t | SIGN_ALGO Signature algorithm identifier (string, read-only). |
| constexpruint32_t | SIGN_HASH Signature hash value (binary, read-only). |
| constexpruint32_t | SIGNATURE Digital signature bytes (binary, read-only). |
| constexpruint32_t | OBJECT_TYPE_NAME Type UUID of the object (read-only, UUID). |
Attributes Documentation
variable OBJECT_TYPE
cpp
constexpr uint32_t flake::ParameterProperties::OBJECT_TYPEType UUID of the object (read-only, UUID).
variable OBJECT_ADDR
cpp
constexpr uint32_t flake::ParameterProperties::OBJECT_ADDRObject address on the bus (read-only, uint16).
variable BROADCAST_ADDR
cpp
constexpr uint32_t flake::ParameterProperties::BROADCAST_ADDRBroadcast / group address (read-only, uint16).
variable MESSAGE_NAME
cpp
constexpr uint32_t flake::ParameterProperties::MESSAGE_NAMEName of the custom message (string).
variable CHILDREN_TABLE
cpp
constexpr uint32_t flake::ParameterProperties::CHILDREN_TABLESerialized table of child objects (binary).
variable COLUMN_SET
cpp
constexpr uint32_t flake::ParameterProperties::COLUMN_SETSet of column tags for table queries (uint16 array).
variable LAST_MODIFICATION_TIME
cpp
constexpr uint32_t flake::ParameterProperties::LAST_MODIFICATION_TIMELast modification timestamp (datetime).
variable CREATION_TIME
cpp
constexpr uint32_t flake::ParameterProperties::CREATION_TIMEObject creation timestamp (datetime).
variable OBJECT_TABLE
cpp
constexpr uint32_t flake::ParameterProperties::OBJECT_TABLESerialized object table (binary).
variable PROP_TAG
cpp
constexpr uint32_t flake::ParameterProperties::PROP_TAGProperty tag value (uint32).
variable PROP_NAME
cpp
constexpr uint32_t flake::ParameterProperties::PROP_NAMEHuman-readable property name (string, read-only).
variable PROP_TYPE
cpp
constexpr uint32_t flake::ParameterProperties::PROP_TYPEProperty type code (uint16).
variable REQUIRES_AUTH
cpp
constexpr uint32_t flake::ParameterProperties::REQUIRES_AUTHWhether the object requires authentication (bool).
variable STREAM_DATA_STR
cpp
constexpr uint32_t flake::ParameterProperties::STREAM_DATA_STRStream payload as string.
variable STREAM_DATA_BIN
cpp
constexpr uint32_t flake::ParameterProperties::STREAM_DATA_BINStream payload as binary blob.
variable STREAM_LEN
cpp
constexpr uint32_t flake::ParameterProperties::STREAM_LENStream data length in bytes (uint16).
variable STREAM_POS
cpp
constexpr uint32_t flake::ParameterProperties::STREAM_POSCurrent stream position (uint32).
variable STREAM_FLAGS
cpp
constexpr uint32_t flake::ParameterProperties::STREAM_FLAGSStream attribute flags (uint8).
variable AUTH_TYPE
cpp
constexpr uint32_t flake::ParameterProperties::AUTH_TYPEAuthentication type (uint8, read-only).
variable AUTH_USER
cpp
constexpr uint32_t flake::ParameterProperties::AUTH_USERAuthentication user name (string, read-only).
variable AUTH_PASS
cpp
constexpr uint32_t flake::ParameterProperties::AUTH_PASSAuthentication password (string, read-only).
variable SIGN_ALGO
cpp
constexpr uint32_t flake::ParameterProperties::SIGN_ALGOSignature algorithm identifier (string, read-only).
variable SIGN_HASH
cpp
constexpr uint32_t flake::ParameterProperties::SIGN_HASHSignature hash value (binary, read-only).
variable SIGNATURE
cpp
constexpr uint32_t flake::ParameterProperties::SIGNATUREDigital signature bytes (binary, read-only).
variable OBJECT_TYPE_NAME
cpp
constexpr uint32_t flake::ParameterProperties::OBJECT_TYPE_NAMEType UUID of the object (read-only, UUID).