UART class of PicoRuby

Include

IRQ

Type aliases

unit_t

Symbol|String

Singleton methods

new

UART.new(
    ?unit: unit_t?,
    ?txd_pin: Integer,
    ?rxd_pin: Integer,
    ?baudrate: Integer,
    ?data_bits: Integer,
    ?stop_bits: Integer,
    ?parity: Integer,
    ?flow_control: Integer,
    ?rts_pin: Integer,
    ?cts_pin: Integer,
    ?rx_buffer_size: Integer?
  ) -> void

Instance methods

break

instance.break(?Integer|Float time) -> self

bytes_available

instance.bytes_available() -> Integer

clear_rx_buffer

instance.clear_rx_buffer() -> self

clear_tx_buffer

instance.clear_tx_buffer() -> self

event_source_id

instance.event_source_id() -> Integer

flush

instance.flush() -> self

getbyte

instance.getbyte() -> (Integer | nil)

gets

instance.gets() -> String?

inject_rx

instance.inject_rx(String bytes) -> Integer

last_read_timestamp_us

instance.last_read_timestamp_us() -> Integer?

line_ending=

instance.line_ending=(("\n"|"\r\n"|"\r") line_ending) -> void

putc

instance.putc((Integer | String) ch) -> (Integer | String)

puts

instance.puts(String str) -> nil

read

instance.read(?Integer len) -> (String | nil)

readpartial

instance.readpartial(Integer maxlen) -> String

rx_overflow_count

instance.rx_overflow_count() -> Integer

set_flow_control

instance.set_flow_control(Integer flow_control, Integer rts_pin, Integer cts_pin) -> void

set_format

instance.set_format(Integer data_bits, Integer stop_bits, Integer parity) -> void

setmode

instance.setmode(
    ?baudrate: Integer?,
    ?data_bits: Integer?,
    ?stop_bits: Integer?,
    ?parity: Integer?,
    ?flow_control: Integer?,
    ?rts_pin: Integer?,
    ?cts_pin: Integer?
  ) -> self

ungetbyte

instance.ungetbyte(Integer byte) -> nil

write

instance.write(String str) -> Integer

Attr accessors

baudrate (reader)

instance.baudrate -> Integer
Tags: class