Crate minitel

Source
Expand description

§Minitel rust stack

This is an experimental rust development stack dedicated to the Minitel.

In its current state, it can be used to:

  • Run on an ESP board such as this one to control the minitel
  • Run on a websocket server to control an emulator such as Miedit on Minipavi
  • Read and Write .vdt files

It includes an integration of ratatui, a library to write console applications.

§Crates and modules

The minitel crate contains everything needed for development, though most its feature are behind feature gates. Its module are:

  • stum: Contains the core functionality, exposing the specificitation described in STUM1B (Spécifications Techniques d’Utilisation du Minitel). Gated behind the stum feature.
  • ws: Websocket integration. Gated behind the ws feature.
  • esp: ESP32 integration. Gated behind the esp feature.
  • ratatui: Ratatui backend module, compatible with both the previous integration. Gated behind the ratatui feature.

These modules are re-export from their respective crates minitel_stum, minitel_ws, minitel_esp and minitel_ratatui, with some additional glue code for common scenarios.

Lastly, [minitel-app-example] is a demonstration application that can be built both as a server serving a websocket, or as an embedded ESP32 firmware.

§Scope and limitations

These crates are focused on the Télétel Vidéotex standard, which is the one specific to the Minitel.

It does not include any management for the “mixte” or “téléinformatique” modes.

§Building minitel-app-example

This crates is a sample app that can be built into a websocket server or an embedded ESP32 plugged on the minitel serial port.

Building for a websocket server: cargo build -p minitel-app-example --features ws.

Building for ESP32: cargo +esp --config minitel-app-example/cargo-config-esp.toml build -p minitel-app-example --features=esp. Targetting an ESP32 requires to have setup an environment ready for ESP32 using the standard library.

§Ratatui integration

minitel::ratatui includes a backend to run ratatui programs on Minitel. This backend supports most of the basic ratatui features.

It carries limitations from the Minitel standard. The most impactful one is the requirement of using space characters for changing certain attributes (background color, invert).

As a result, to control the background color, you must ensure to start the area with a space. Block’s padding are useful to ensure this is the case, by adding a left padding: .padding(Padding::left(1)).

The current implementation does not take advantage of the Repeat control code, making page drawing slower than it should.

§ESP32 toolchain

Using the esp feature requires to have setup an environment ready for ESP32 using the standard library.

By default, on docs.rs a fake documentation stub will be built for the main esp members. The actual doc can be built with cargo +esp doc --config minitel-app-example/cargo-config-esp.toml --features ratatui,esp --open

§Release

cargo publish -p minitel-stum
cargo publish -p minitel-ws
cargo publish -p minitel-ratatui
cargo +esp publish --config minitel-app-example/cargo-config-esp.toml -p minitel-esp
cargo publish -p minitel

Modules§

Structs§

Functions§

  • esp_minitel
    Build a Minitel terminal on an ESP32
  • esp_minitel_uart2
    Minitel terminal running on a ESP32
  • esp_terminal
    Build a Minitel terminal on an ESP32 for ratatui applications
  • ws_minitel
    Build a Minitel terminal over a websocket connection
  • ws_terminal
    Build a Minitel terminal over a websocket connection for ratatui applications

Type Aliases§

  • ESPTerminal
    Minitel terminal running on a ESP32 for ratatui applications
  • WSMinitel
    Minitel terminal used over a websocket connection
  • WSTerminal
    Websocket Minitel terminal used in ratatui applications