Lib.rs

Cargo Features

[dependencies]
rmk = { version = "0.1.15", default-features = false, features = ["col2row", "rapid_debouncer", "nrf52840_ble", "nrf52832_ble", "esp32c3_ble", "esp32s3_ble"] }

default = col2row, rapid_debouncer

These default features are set whenever rmk is added without default-features = false somewhere in the dependency tree.

col2row default

If your PCB diode's direction is col2row, enable this feature. If it's row2col, disable this feature.

rapid_debouncer default

Use rapid debouncer

nrf52840_ble = _nrf_ble

BLE feature flags

⚠️ Due to the limitation of docs.rs, functions gated by BLE features won't show in docs.rs. You have to head to examples folder of RMK repo for their usages. Enable feature if you want to use nRF52840 with BLE.

Enables embassy-nrf, nrf52840 and s140 of nrf-softdevice and once_cell

Optional dependencies
nRF dependencies

Affects nrf::SOFTWARE_VBUS…

nrf52832_ble = _nrf_ble

Enable feature if you want to use nRF52832 with BLE.

Enables embassy-nrf, once_cell, nrf52832 and s132 of nrf-softdevice

esp32c3_ble = _esp_ble

Enable feature if you want to use ESP32C3 with BLE.

esp32s3_ble = _esp_ble

Enable feature if you want to use ESP32S3 with BLE.

_esp_ble esp32c3_ble? esp32s3_ble? = _ble

Enables std of ssmarshal and esp-idf-svc, esp32-nimble, and rmk-config

esp32-nimble:

Espressif dependencies

Affects ble::esp…

_nrf_ble nrf52832_ble? nrf52840_ble? = _ble

Enables nrf-softdevice, embassy-nrf of rmk-config

Affects ble::nrf…

_ble _esp_ble? _nrf_ble?

Affects rmk::ble…