MIP_SDK  latest-2-g34f3e39
MicroStrain Communications Library for embedded systems
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
mip::commands_base::CommSpeed Struct Reference

#include <commands_base.hpp>

Classes

struct  Response
 

Public Member Functions

auto asTuple () const
 
auto asTuple ()
 
void insert (Serializer &serializer) const
 Serialization. More...
 
void extract (Serializer &serializer)
 

Static Public Member Functions

static CommSpeed create_sld_all (::mip::FunctionSelector function)
 

Public Attributes

FunctionSelector function = static_cast<FunctionSelector>(0)
 Parameters. More...
 
uint8_t port = 0
 Port ID number, starting with 1. When function is SAVE, LOAD, or DEFAULT, this can be 0 to apply to all ports. See the device user manual for details. More...
 
uint32_t baud = 0
 Port baud rate. Must be a supported rate. More...
 

Static Public Attributes

static constexpr const uint32_t ALL_PORTS = 0
 
static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_base::DESCRIPTOR_SET
 Descriptors. More...
 
static constexpr const uint8_t FIELD_DESCRIPTOR = ::mip::commands_base::CMD_COMM_SPEED
 
static constexpr const CompositeDescriptor DESCRIPTOR = {DESCRIPTOR_SET, FIELD_DESCRIPTOR}
 
static constexpr const char * NAME = "CommSpeed"
 
static constexpr const char * DOC_NAME = "Comm Port Speed"
 
static constexpr const bool HAS_FUNCTION_SELECTOR = true
 

Member Function Documentation

◆ asTuple() [1/2]

auto mip::commands_base::CommSpeed::asTuple ( )
inline

◆ asTuple() [2/2]

auto mip::commands_base::CommSpeed::asTuple ( ) const
inline

◆ create_sld_all()

static CommSpeed mip::commands_base::CommSpeed::create_sld_all ( ::mip::FunctionSelector  function)
inlinestatic

◆ extract()

void mip::commands_base::CommSpeed::extract ( Serializer serializer)

◆ insert()

void mip::commands_base::CommSpeed::insert ( Serializer serializer) const

Serialization.

Member Data Documentation

◆ ALL_PORTS

constexpr const uint32_t mip::commands_base::CommSpeed::ALL_PORTS = 0
staticconstexpr

◆ baud

uint32_t mip::commands_base::CommSpeed::baud = 0

Port baud rate. Must be a supported rate.

◆ DESCRIPTOR

constexpr const CompositeDescriptor mip::commands_base::CommSpeed::DESCRIPTOR = {DESCRIPTOR_SET, FIELD_DESCRIPTOR}
staticconstexpr

◆ DESCRIPTOR_SET

constexpr const uint8_t mip::commands_base::CommSpeed::DESCRIPTOR_SET = ::mip::commands_base::DESCRIPTOR_SET
staticconstexpr

Descriptors.

◆ DOC_NAME

constexpr const char* mip::commands_base::CommSpeed::DOC_NAME = "Comm Port Speed"
staticconstexpr

◆ FIELD_DESCRIPTOR

constexpr const uint8_t mip::commands_base::CommSpeed::FIELD_DESCRIPTOR = ::mip::commands_base::CMD_COMM_SPEED
staticconstexpr

◆ function

FunctionSelector mip::commands_base::CommSpeed::function = static_cast<FunctionSelector>(0)

Parameters.

◆ HAS_FUNCTION_SELECTOR

constexpr const bool mip::commands_base::CommSpeed::HAS_FUNCTION_SELECTOR = true
staticconstexpr

◆ NAME

constexpr const char* mip::commands_base::CommSpeed::NAME = "CommSpeed"
staticconstexpr

◆ port

uint8_t mip::commands_base::CommSpeed::port = 0

Port ID number, starting with 1. When function is SAVE, LOAD, or DEFAULT, this can be 0 to apply to all ports. See the device user manual for details.


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