Skip to content

Latest commit

 

History

History
38 lines (32 loc) · 2.57 KB

UARTConfiguration.md

File metadata and controls

38 lines (32 loc) · 2.57 KB

class UARTConfiguration

Member values

Member name Data type Description
port_id uint32 UART port identification
enabled bool True if UART device is enabled, false otherwise
speed uint32 Speed selection
word_length uint32 Word length
stop_bits uint32 Stop bits
parity uint32 Parity mode

Member functions

Function name Return type Input type Description
port_id() uint32 void Returns the current value of port_id. If the port_id is not set, returns 0.
set_port_id() void uint32 Sets the value of port_id. After calling this, port_id() will return value.
clear_port_id() void void Clears the value of port_id. After calling this, port_id() will return 0.
enabled() bool void Returns the current value of enabled. If the enabled is not set, returns 0.
set_enabled() void bool Sets the value of enabled. After calling this, enabled() will return value.
clear_enabled() void void Clears the value of enabled. After calling this, enabled() will return 0.
speed() const uint32 void Returns the current value of speed. If the speed is not set, returns 0.
set_speed() void uint32 Sets the value of speed. After calling this, speed() will return value.
clear_speed() void void Clears the value of speed. After calling this, speed() will return the empty string/empty bytes.
word_length() const uint32 void Returns the current value of word_length. If the word_length is not set, returns 0.
set_word_length() void uint32 Sets the value of word_length. After calling this, word_length() will return value.
clear_word_length() void void Clears the value of word_length. After calling this, word_length() will return the empty string/empty bytes.
stop_bits() const uint32 void Returns the current value of stop_bits. If the stop_bits is not set, returns 0.
set_stop_bits() void uint32 Sets the value of stop_bits. After calling this, stop_bits() will return value.
clear_stop_bits() void void Clears the value of stop_bits. After calling this, stop_bits() will return the empty string/empty bytes.
parity() const uint32 void Returns the current value of parity. If the parity is not set, returns 0.
set_parity() void uint32 Sets the value of parity. After calling this, parity() will return value.
clear_parity() void void Clears the value of parity. After calling this, parity() will return the empty string/empty bytes.

Parent topic: Common (C++)