Syntalos::FirmataControl

Syntalos::FirmataControl

Syntalos::FirmataControl

Commands to control Firmata output.

#include <datatypes.h>

Inherits from Syntalos::BaseDataType

Public Functions

Name
FirmataControl()
FirmataControl(FirmataCommandKind cmd)
FirmataControl(FirmataCommandKind kind, int pinId, std::string name =std::string())
FirmataControl(FirmataCommandKind kind, std::string name)
virtual booltoBytes(ByteVector & output) const override
Serialize the data to a byte array.
FirmataControlfromMemory(const void * memory, size_t size)

Public Attributes

Name
FirmataCommandKindcommand
uint8_tpinId
std::stringpinName
boolisOutput
boolisPullUp
uint16_tvalue

Additional inherited members

Public Types inherited from Syntalos::BaseDataType

Name
enumTypeId { Unknown, ControlCommand, TableRow, Frame, FirmataControl, FirmataData, IntSignalBlock, FloatSignalBlock, Last}
The TypeId enum.

Public Functions inherited from Syntalos::BaseDataType

Name
virtual~BaseDataType() =default
virtual TypeIdtypeId() const =0
virtual ssize_tmemorySize() const
Calculate the size of the data in memory.
virtual boolwriteToMemory(void * memory, ssize_t size =-1) const
Write the data to a memory block.
std::stringtypeIdToString(int value)
std::stringtypeIdToString(TypeId value)
TypeIdtypeIdFromString(const std::string & str)

Public Functions Documentation

function FirmataControl

inline explicit FirmataControl()

function FirmataControl

inline explicit FirmataControl(
    FirmataCommandKind cmd
)

function FirmataControl

inline FirmataControl(
    FirmataCommandKind kind,
    int pinId,
    std::string name =std::string()
)

function FirmataControl

inline FirmataControl(
    FirmataCommandKind kind,
    std::string name
)

function toBytes

inline virtual bool toBytes(
    ByteVector & output
) const override

Serialize the data to a byte array.

Reimplements: Syntalos::BaseDataType::toBytes

Serialize the data to a byte array for local transmission.

function fromMemory

static inline FirmataControl fromMemory(
    const void * memory,
    size_t size
)

Public Attributes Documentation

variable command

FirmataCommandKind command;

variable pinId

uint8_t pinId {0};

variable pinName

std::string pinName;

variable isOutput

bool isOutput {false};

variable isPullUp

bool isPullUp {false};

variable value

uint16_t value;

Updated on 2026-03-16 at 19:16:01 +0000