Struct Minitel

pub struct Minitel<S> {
    pub port: S,
}

Minitel interface, the entry point to the library

This struct wraps a serial port (websocket, physical, file, …) and provides methods to interact with the device.

This struct can be initialized using the ws_minitel, esp_minitel or esp_minitel_uart2 functions, depending on the target platform and enabled features. It can also operate on any std::io::Read and/or std::io::Write object.

Fields

port: S

Implementations

impl<S> Minitel<S>

pub fn new(port: S) -> Minitel<S>

impl<S> Minitel<S>

where S: MinitelRead + MinitelWrite,

pub fn clear_screen(&mut self) -> Result<(), Error>

pub fn read_rom(&mut self) -> Result<Rom, Error>

pub fn get_pos(&mut self) -> Result<(u8, u8), Error>

pub fn set_function_mode( &mut self, mode: FunctionMode, enable: bool, ) -> Result<(), Error>

pub fn set_routing( &mut self, enable: bool, recepter: RoutingRx, emitter: RoutingTx, ) -> Result<(), Error>

pub fn get_speed(&mut self) -> Result<Baudrate, Error>

pub fn set_rouleau(&mut self, enable: bool) -> Result<(), Error>

pub fn set_procedure(&mut self, enable: bool) -> Result<(), Error>

pub fn set_minuscule(&mut self, enable: bool) -> Result<(), Error>

impl<S> Minitel<S>

where S: MinitelRead,

pub fn read_bytes(&mut self, data: &mut [u8]) -> Result<(), Error>

Read a raw sequence from the minitel

pub fn read_byte(&mut self) -> Result<u8, Error>

Read a single byte from the minitel

pub fn read_s0_stroke(&mut self) -> Result<UserInput, Error>

Read a key stroke from the minitel assuming it is in S0 (text) mode.

G0 and G2 characters are returned as unicode characters.

pub fn wait_for(&mut self, byte: impl Into<u8> + Copy) -> Result<(), Error>

pub fn expect_read(&mut self, byte: impl Into<u8> + Copy) -> Result<(), Error>

pub fn read_pro2(&mut self, expected_ack: Pro2Resp) -> Result<u8, Error>

pub fn read_pro3(&mut self, expected_ack: Pro3Resp) -> Result<(u8, u8), Error>

impl<S> Minitel<S>

where S: MinitelWrite,

pub fn write_bytes(&mut self, data: &[u8]) -> Result<(), Error>

Write a raw sequence to the minitel

pub fn write_byte<T>(&mut self, byte: T) -> Result<(), Error>

where T: Into<u8> + Copy,

Write a single byte to the minitel

pub fn flush(&mut self) -> Result<(), Error>

Flush the serial port

pub fn write_sequence<const N: usize>( &mut self, sequence: impl IntoSequence<N>, ) -> Result<(), Error>

pub fn c1(&mut self, c1: C1) -> Result<(), Error>

pub fn write_g2(&mut self, g2: G2) -> Result<(), Error>

pub fn show_cursor(&mut self) -> Result<(), Error>

pub fn hide_cursor(&mut self) -> Result<(), Error>

pub fn set_pos(&mut self, x: u8, y: u8) -> Result<(), Error>

pub fn cursor_down(&mut self) -> Result<(), Error>

pub fn cursor_up(&mut self) -> Result<(), Error>

pub fn cursor_right(&mut self) -> Result<(), Error>

pub fn cursor_left(&mut self) -> Result<(), Error>

pub fn start_zone(&mut self, funcs: &[C1]) -> Result<(), Error>

pub fn zone_delimiter(&mut self) -> Result<(), Error>

pub fn write_char(&mut self, c: char) -> Result<(), Error>

pub fn si_char(&mut self, c: SIChar) -> Result<(), Error>

pub fn write_str(&mut self, s: &str) -> Result<(), Error>

pub fn writeln(&mut self, s: &str) -> Result<(), Error>

pub fn pro1(&mut self, x: Pro1) -> Result<(), Error>

Protocol command with a single argument

pub fn pro2(&mut self, x: Pro2, y: impl Into<u8> + Copy) -> Result<(), Error>

Protocol command with two arguments

pub fn pro3( &mut self, x: Pro3, y: impl Into<u8> + Copy, z: impl Into<u8> + Copy, ) -> Result<(), Error>

Protocol command with three arguments

impl<S> Minitel<S>

where S: MinitelRead + MinitelWrite + MinitelBaudrateControl,

Ability to communicate with a minitel through a serial port with baudrate control

pub fn search_speed(&mut self) -> Result<Baudrate, Error>

pub fn set_speed(&mut self, baudrate: Baudrate) -> Result<Baudrate, Error>