summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBirte Kristina Friesel <derf@finalrewind.org>2024-01-28 09:50:58 +0100
committerBirte Kristina Friesel <derf@finalrewind.org>2024-01-28 09:50:58 +0100
commit590d33b282c1205f824b614725e9b0506b86804c (patch)
tree0daeb9f068222d9d7c4d19e4117363ddf2d77d99 /README.md
parente5cb390a119256096a33cb0f62527b73c0b3cdc4 (diff)
README: sort peripherals by type (sensor/actuator/extension)
Diffstat (limited to 'README.md')
-rw-r--r--README.md50
1 files changed, 31 insertions, 19 deletions
diff --git a/README.md b/README.md
index d74ab44..a84ae58 100644
--- a/README.md
+++ b/README.md
@@ -3,8 +3,9 @@
**multipass** is a C++ Library Operating System for a few embedded
architectures. As such, it does not provide multi-threading support or similar
conveniences. Its objective is similar to the Arduino environment: provide a
-simple framework for embedded application/driver development and evaluation,
-and get out of the way as much as possible. It favors simplicity over
+simple framework for embedded application/driver development and evaluation
+with a `main()` and optional `loop()` function and a text output channel, and
+then get out of the way as much as possible. It favors simplicity over
performance and proper abstraction. Re-using components outside of multipass
should be fairly easy.
@@ -101,23 +102,34 @@ Peripheral communication:
* IĀ²C controller via `/dev/i2c`
* stdin/stdout
-## Included Drivers
+## Supported Peripherals
See `make config` for an up-to-date list.
-* AM2320 IĀ²C Temperature and Humidity Sensor
-* BME280 IĀ²C Temperature, Humidity, and Pressure Sensor (Bosch SensorTec driver)
-* BME680 IĀ²C Temperature, Humidity, Pressure, and Air Quality Sensor (Bosch SensorTec driver)
-* CCS811 IĀ²C Air Quality Sensor
-* DS2482 IĀ²C 1-Wire Bus Controller
-* HDC1080 IĀ²C Temperature and Humidity Sensor
-* LM75 IĀ²C Temperature Sensor
-* LS013B4DN04 96Ɨ96 transflective LCD (430BOOST-SHARP96)
-* MAX44006 IĀ²C RGB and IR Light Sensor
-* MAX44009 IĀ²C Light Sensor
-* MPU9250 IĀ²C Accelerometer, Gyroscope, and Magnetometer Sensor
-* Pervasive Aurora Mb V230/V231 4.2" iTC E-Paper Display via EPD Extension Board Gen 2
-* SCD40/SCD41 IĀ²C COā‚‚ Sensor
-* SEN5x IĀ²C particulate matter (PM1.0/PM2.5/PM4.0/PM10) and VOC sensor
-* SSD1306 IĀ²C OLED Display Controller
-* VEML6075 IĀ²C UVA/UVB Light Sensor
+### Sensors
+
+* AM2320 Temperature+Humidity (IĀ²C)
+* BME280 Temperature+Humidity+Pressure via Bosch SensorTec driver (IĀ²C)
+* BME280 Temperature+Humidity+Pressure+IAQ via Bosch SensorTec driver (IĀ²C)
+* CCS811 VOC (IĀ²C)
+* HDC1080 Temperature+Humidity (IĀ²C)
+* LM75 Temperature (IĀ²C)
+* MAX44006 R+G+B+Clear+IR irradiance (IĀ²C)
+* MAX44009 illuminance (IĀ²C)
+* MPU9250 accelerometer+gyroscope+magnetometer (IĀ²C)
+* SCD4x COā‚‚+Temperature+Humidity (IĀ²C)
+* SEN5x PM1.0+PM2.5+PM4.0+PM10+Temperature+Humidity+VOC (IĀ²C)
+* VEML6075 UVA+UVB irradiance (IĀ²C)
+
+"VOC" refers to volatile organic compounds; "PM" refers to particulate matter.
+
+### Displays
+
+* LS013B4DN04 / 430BOOST-SHARP96 96Ɨ96 transflective LCD (SPI)
+* Pervasive Aurora Mb V230/V231 4.2" iTC E-Paper Display via EPD Extension Board Gen 2 (SPI)
+* SSD1306 128Ɨ64 / 128Ɨ32 OLED display controller (IĀ²C)
+
+### Others
+
+* ADS111x ADC (IĀ²C)
+* DS2482 1-Wire Bus Controller (IĀ²C)