Skip to content

Commit ea35e0e

Browse files
Fix enumerations
1 parent b068d85 commit ea35e0e

File tree

6 files changed

+34
-34
lines changed

6 files changed

+34
-34
lines changed

docs/frameworks/audioflinger.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ MicroPythonOS provides a centralized audio service called **AudioFlinger**, insp
66

77
AudioFlinger provides:
88

9-
**Priority-based audio focus** - Higher priority streams interrupt lower priority ones
10-
**Multiple audio devices** - I2S digital audio, PWM buzzer, or both
11-
**Background playback** - Runs in separate thread
12-
**WAV file support** - 8/16/24/32-bit PCM, mono/stereo, auto-upsampling
13-
**RTTTL ringtone support** - Full Ring Tone Text Transfer Language parser
14-
**Thread-safe** - Safe for concurrent access
15-
**Hardware-agnostic** - Apps work across all platforms without changes
9+
- **Priority-based audio focus** - Higher priority streams interrupt lower priority ones
10+
- **Multiple audio devices** - I2S digital audio, PWM buzzer, or both
11+
- **Background playback** - Runs in separate thread
12+
- **WAV file support** - 8/16/24/32-bit PCM, mono/stereo, auto-upsampling
13+
- **RTTTL ringtone support** - Full Ring Tone Text Transfer Language parser
14+
- **Thread-safe** - Safe for concurrent access
15+
- **Hardware-agnostic** - Apps work across all platforms without changes
1616

1717
## Supported Audio Devices
1818

docs/frameworks/download-manager.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ MicroPythonOS provides a centralized HTTP download service called **DownloadMana
66

77
DownloadManager provides:
88

9-
**Three output modes** - Download to memory, file, or stream with callbacks
10-
**Automatic session management** - Shared aiohttp session with connection reuse
11-
**Thread-safe** - Safe for concurrent downloads across apps
12-
**Progress tracking** - Real-time download progress callbacks
13-
**Retry logic** - Automatic retry on chunk failures (3 attempts)
14-
**Resume support** - HTTP Range headers for partial downloads
15-
**Memory efficient** - Chunked downloads (1KB chunks)
9+
- **Three output modes** - Download to memory, file, or stream with callbacks
10+
- **Automatic session management** - Shared aiohttp session with connection reuse
11+
- **Thread-safe** - Safe for concurrent downloads across apps
12+
- **Progress tracking** - Real-time download progress callbacks
13+
- **Retry logic** - Automatic retry on chunk failures (3 attempts)
14+
- **Resume support** - HTTP Range headers for partial downloads
15+
- **Memory efficient** - Chunked downloads (1KB chunks)
1616

1717
## Quick Start
1818

docs/frameworks/lights-manager.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ MicroPythonOS provides a simple LED control service called **LightsManager** for
66

77
LightsManager provides:
88

9-
**One-shot LED control** - Direct control of individual or all LEDs
10-
**Buffered updates** - Set multiple LEDs then apply all changes at once
11-
**Hardware abstraction** - Same API works across all boards
12-
**Predefined colors** - Quick access to common notification colors
13-
**Frame-based animations** - Integrate with TaskHandler for smooth animations
14-
**Low overhead** - Lightweight singleton pattern
9+
- **One-shot LED control** - Direct control of individual or all LEDs
10+
- **Buffered updates** - Set multiple LEDs then apply all changes at once
11+
- **Hardware abstraction** - Same API works across all boards
12+
- **Predefined colors** - Quick access to common notification colors
13+
- **Frame-based animations** - Integrate with TaskHandler for smooth animations
14+
- **Low overhead** - Lightweight singleton pattern
1515

1616
⚠️ **Note**: LightsManager provides primitives for LED control, not built-in animations. Apps implement custom animations using the `update_frame()` pattern.
1717

docs/frameworks/sensor-manager.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ SensorManager automatically detects available sensors on your device:
1212

1313
The framework handles:
1414

15-
**Auto-detection** - Identifies which IMU is present
16-
**Unit normalization** - Returns standard SI units (m/s², deg/s, °C)
17-
**Persistent calibration** - Calibrate once, saved across reboots
18-
**Thread-safe** - Safe for concurrent access
19-
**Hardware-agnostic** - Apps work on all platforms without changes
15+
- **Auto-detection** - Identifies which IMU is present
16+
- **Unit normalization** - Returns standard SI units (m/s², deg/s, °C)
17+
- **Persistent calibration** - Calibrate once, saved across reboots
18+
- **Thread-safe** - Safe for concurrent access
19+
- **Hardware-agnostic** - Apps work on all platforms without changes
2020

2121
## Sensor Types
2222

docs/frameworks/task-manager.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ MicroPythonOS provides a centralized task management service called **TaskManage
66

77
TaskManager provides:
88

9-
**Simplified async interface** - Easy wrappers around uasyncio primitives
10-
**Task creation** - Launch background coroutines without boilerplate
11-
**Sleep operations** - Async delays in seconds or milliseconds
12-
**Timeouts** - Wait for operations with automatic timeout handling
13-
**Event notifications** - Simple async event signaling
14-
**Centralized management** - Single point of control for all async operations
9+
- **Simplified async interface** - Easy wrappers around uasyncio primitives
10+
- **Task creation** - Launch background coroutines without boilerplate
11+
- **Sleep operations** - Async delays in seconds or milliseconds
12+
- **Timeouts** - Wait for operations with automatic timeout handling
13+
- **Event notifications** - Simple async event signaling
14+
- **Centralized management** - Single point of control for all async operations
1515

1616
## Quick Start
1717

docs/os-development/running-on-desktop.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@
4242
4343
When you run `./scripts/run_desktop.sh`, the OS runs **directly from `internal_filesystem/`**. This means:
4444
45-
**All changes to Python files are immediately active** - no build or install needed
46-
**Instant testing** - edit a file, restart the app, see the changes
47-
**Fast iteration cycle** - the recommended way to develop and test
45+
- **All changes to Python files are immediately active** - no build or install needed
46+
- **Instant testing** - edit a file, restart the app, see the changes
47+
- **Fast iteration cycle** - the recommended way to develop and test
4848
4949
**DO NOT run `./scripts/install.sh` when testing on desktop!** That script is only for deploying to physical hardware.
5050

0 commit comments

Comments
 (0)