mm::node::EncoderRegisterRequest Struct Reference

What one encoder register access was asked to do. More...

#include <somanet_procedures.h>

Public Attributes
somanet::EncoderOrdinal	encoder {somanet::EncoderOrdinal::kEncoder1}
	Which encoder.
bool	write = false
	Write the register rather than read it.
uint8_t	registerAddress = 0
	The register to access; no default, so a request must say.
uint8_t	value = 0
	The byte to write; ignored when reading.

Detailed Description

What one encoder register access was asked to do.

The request behind POST /api/devices/:pos/procedures/encoder-register-communication, and the first procedure request made of named parameters rather than raw command bytes — which is what ProcedureParameter exists to describe.

Member Data Documentation

encoder

somanet::EncoderOrdinal mm::node::EncoderRegisterRequest::encoder {somanet::EncoderOrdinal::kEncoder1}

Which encoder.

registerAddress

uint8_t mm::node::EncoderRegisterRequest::registerAddress = 0

The register to access; no default, so a request must say.

value

uint8_t mm::node::EncoderRegisterRequest::value = 0

The byte to write; ignored when reading.

write

bool mm::node::EncoderRegisterRequest::write = false

Write the register rather than read it.

---

The documentation for this struct was generated from the following file:

• libs/node/somanet_procedures.h