MIP SDK  0.0.1
MicroStrain Communications Library for embedded systems
Classes | Functions
(0x01,0x09) Comm Speed [CPP]
Collaboration diagram for (0x01,0x09) Comm Speed [CPP]:

Classes

struct  mip::commands_base::CommSpeed
 

Functions

void mip::commands_base::insert (Serializer &serializer, const CommSpeed &self)
 
void mip::commands_base::extract (Serializer &serializer, CommSpeed &self)
 
void mip::commands_base::insert (Serializer &serializer, const CommSpeed::Response &self)
 
void mip::commands_base::extract (Serializer &serializer, CommSpeed::Response &self)
 
CmdResult mip::commands_base::writeCommSpeed (C::mip_interface &device, uint8_t port, uint32_t baud)
 
CmdResult mip::commands_base::readCommSpeed (C::mip_interface &device, uint8_t port, uint32_t *baudOut)
 
CmdResult mip::commands_base::saveCommSpeed (C::mip_interface &device, uint8_t port)
 
CmdResult mip::commands_base::loadCommSpeed (C::mip_interface &device, uint8_t port)
 
CmdResult mip::commands_base::defaultCommSpeed (C::mip_interface &device, uint8_t port)
 

Detailed Description

Controls the baud rate of a specific port on the device.

Please see the device user manual for supported baud rates on each port.

The device will wait until all incoming and outgoing data has been sent, up to a maximum of 250 ms, before applying any change.

No guarantee is provided as to what happens to commands issued during this delay period; They may or may not be processed and any responses aren't guaranteed to be at one rate or the other. The same applies to data packets.

It is highly recommended that the device be idle before issuing this command and that it be issued in its own packet. Users should wait 250 ms after sending this command before further interaction.

Function Documentation

◆ defaultCommSpeed()

CmdResult mip::commands_base::defaultCommSpeed ( C::mip_interface device,
uint8_t  port 
)

◆ extract() [1/2]

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

◆ extract() [2/2]

void mip::commands_base::extract ( Serializer serializer,
CommSpeed::Response self 
)

◆ insert() [1/2]

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

◆ insert() [2/2]

void mip::commands_base::insert ( Serializer serializer,
const CommSpeed::Response self 
)

◆ loadCommSpeed()

CmdResult mip::commands_base::loadCommSpeed ( C::mip_interface device,
uint8_t  port 
)

◆ readCommSpeed()

CmdResult mip::commands_base::readCommSpeed ( C::mip_interface device,
uint8_t  port,
uint32_t *  baudOut 
)

◆ saveCommSpeed()

CmdResult mip::commands_base::saveCommSpeed ( C::mip_interface device,
uint8_t  port 
)

◆ writeCommSpeed()

CmdResult mip::commands_base::writeCommSpeed ( C::mip_interface device,
uint8_t  port,
uint32_t  baud 
)