modulino 0.3.0

A hardware-agnostic, no_std Rust driver for Arduino Modulino breakout boards
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175

//! # Modulino
//!
//! A hardware-agnostic, `no_std` Rust driver for Arduino Modulino breakout boards.
//!
//! This crate provides drivers for the following Modulino devices:
//!
//! - [`Buttons`] - Three-button module with LEDs
//! - [`Buzzer`] - Piezo speaker module
//! - [`Pixels`] - 8 RGB LED module (APA102-compatible)
//! - [`Distance`] - Time-of-Flight distance sensor (VL53L4CD)
//! - [`Movement`] - IMU module (LSM6DSOX accelerometer/gyroscope)
//! - [`Knob`] - Rotary encoder with button
//! - [`Thermo`] - Temperature and humidity sensor (wraps [`hs3003`](https://crates.io/crates/hs3003) crate)
//! - [`Joystick`] - Analog joystick with button
//! - [`LatchRelay`] - Latching relay module
//! - [`Vibro`] - Vibration motor module
//! - [`LedMatrix`] - 12x8 LED matrix display
//! - [`Pressure`] - Barometric pressure and temperature sensor
//! - [`Light`] - RGB and ambient light sensor
//!
//! ## Example
//!
//! ```rust,ignore
//! use modulino::{Pixels, Color};
//!
//! // Create a Pixels instance with your I2C bus
//! let mut pixels = Pixels::new(i2c)?;
//!
//! // Set the first LED to red
//! pixels.set_color(0, Color::RED, 50)?;
//!
//! // Apply the changes
//! pixels.show()?;
//! ```
//!
//! ## Features
//!
//! - `defmt`: Enable `defmt` debug formatting for error types
//!
//! ## Hardware Requirements
//!
//! All Modulino devices communicate over I2C at 100kHz. They use the Qwiic/STEMMA QT
//! connector standard for easy daisy-chaining.

#![no_std]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![warn(missing_docs)]
#![deny(unsafe_code)]

mod buttons;
mod buzzer;
mod color;
mod distance;
mod error;
mod hub;
mod i2c_device;
mod joystick;
mod knob;
mod latch_relay;
mod led_matrix;
mod light;
mod motors;
mod movement;
mod opto_relay;
mod pixels;
mod pressure;
mod thermo;
mod vibro;

pub use buttons::{ButtonLed, ButtonState, Buttons};
pub use buzzer::{Buzzer, Note};
pub use color::Color;
pub use distance::Distance;
pub use error::{Error, Result};
pub use hub::{Hub, HubPort};
pub use i2c_device::I2cDevice;
pub use joystick::Joystick;
pub use knob::Knob;
pub use latch_relay::LatchRelay;
pub use led_matrix::{DisplayMode, LedMatrix};
pub use light::{Gain, Light, LightMeasurement, MeasurementRate, Resolution};
pub use motors::{DecayMode, Motors};
pub use movement::{Movement, MovementValues};
pub use opto_relay::OptoRelay;
pub use pixels::Pixels;
pub use pressure::Pressure;
pub use thermo::{Hs3003Error, Thermo, ThermoMeasurement};
pub use vibro::{PowerLevel, Vibro};

/// Default I2C addresses for Modulino devices.
///
/// These are the factory-default 7-bit I2C addresses. Some modules support
/// multiple addresses via hardware configuration (solder jumpers).
pub mod addresses {
    /// Default address for Modulino Buttons (0x7C >> 1 = 0x3E)
    pub const BUTTONS: u8 = 0x3E;

    /// Default address for Modulino Buzzer (0x3C >> 1 = 0x1E)
    pub const BUZZER: u8 = 0x1E;

    /// Default address for Modulino Pixels (0x6C >> 1 = 0x36)
    pub const PIXELS: u8 = 0x36;

    /// Default address for Modulino Distance
    pub const DISTANCE: u8 = 0x29;

    /// Default addresses for Modulino Movement (configurable via solder jumper)
    pub const MOVEMENT: [u8; 2] = [0x6A, 0x6B];

    /// Default addresses for Modulino Knob (two possible addresses)
    pub const KNOB: [u8; 2] = [0x3A, 0x3B]; // 0x74 >> 1, 0x76 >> 1

    /// Default address for Modulino Thermo
    pub const THERMO: u8 = 0x44;

    /// Default address for Modulino Joystick (0x58 >> 1 = 0x2C)
    pub const JOYSTICK: u8 = 0x2C;

    /// Default address for Modulino Latch Relay (0x04 >> 1 = 0x02)
    pub const LATCH_RELAY: u8 = 0x02;

    /// Default address for Modulino Opto Relay (0x28 >> 1 = 0x14)
    pub const OPTO_RELAY: u8 = 0x14;

    /// Default address for Modulino Vibro (0x70 >> 1 = 0x38)
    pub const VIBRO: u8 = 0x38;

    /// Default address for Modulino Light
    pub const LIGHT: u8 = 0x53;

    /// Default address for Modulino Pressure
    pub const PRESSURE: u8 = 0x5C;

    /// Default address for Modulino LED Matrix
    pub const LED_MATRIX: u8 = 0x39;

    /// Default address for Modulino Hub (0x70)
    pub const HUB: u8 = 0x70;

    /// Default address for Modulino Motors (0x48 >> 1 = 0x24)
    pub const MOTORS: u8 = 0x24;
}

/// Pinstrap address map for device type detection.
///
/// When reading from a Modulino with a microcontroller, the first byte
/// returned is always the pinstrap address, which identifies the device type.
pub mod pinstrap {
    /// Pinstrap address for Buzzer
    pub const BUZZER: u8 = 0x3C;

    /// Pinstrap address for Buttons
    pub const BUTTONS: u8 = 0x7C;

    /// Pinstrap addresses for Knob
    pub const KNOB: [u8; 2] = [0x76, 0x74];

    /// Pinstrap address for Pixels
    pub const PIXELS: u8 = 0x6C;

    /// Pinstrap address for Joystick
    pub const JOYSTICK: u8 = 0x58;

    /// Pinstrap address for Latch Relay
    pub const LATCH_RELAY: u8 = 0x04;

    /// Pinstrap address for Opto Relay
    pub const OPTO_RELAY: u8 = 0x28;

    /// Pinstrap address for Vibro
    pub const VIBRO: u8 = 0x70;

    /// Pinstrap address for Motors
    pub const MOTORS: u8 = 0x48;
}