doc: improve & complete documentation on many sensors

[contrib/upm.git] / README.md

diff --git a/README.md b/README.md
index f7c80ce..5fe9467 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
-UPM - Sensor/Actuator repository for Maa
+UPM - Sensor/Actuator repository for Mraa
 ==============
 
-UPM is a high level repository for sensors that use maa. Each sensor links to
-libmaa and are not meant to be interlinked although some groups of sensors may
+UPM is a high level repository for sensors that use mraa. Each sensor links to
+libmraa and are not meant to be interlinked although some groups of sensors may
 be. Each sensor contains a header which allows to interface with it. Typically
 a sensor is represented as a class and instanciated.
 
@@ -21,6 +21,58 @@ However implementation and API design is compeltely up to the developer, some
 enumerable sensors for example may provide much clever instanciation. Displays
 may also create more complex structures in order to interface with them.
 
+### Supported Sensors
+
+Temperature Sensors:
+  * upm::MAX31723
+  * upm::MAX31855
+  * upm::TH02
+  * upm::GroveTemp
+
+Compass/Gyro/Magnometer Sensors:
+  * upm::Hmc5883l
+  * upm::MPU9150
+
+Atmospheric Pressure Sensors:
+  * upm::GY65
+
+Light/Proximity Sensors:
+  * upm::MAXDS3231M
+  * upm::MAX44000
+  * upm::HCSR04
+  * upm::GroveLight
+
+Gas Sensors:
+  * upm::MQ2
+  * upm::MQ3
+  * upm::MQ5
+  * upm::MQ9
+
+Displays:
+  * upm::Jhd1313m1
+  * upm::Lcm1602
+  * upm::ST7735
+  * upm::SSD1308
+  * upm::SSD1327
+
+LED controllers/segment displays:
+  * upm::TM1637
+  * upm::MY9221
+
+RFID:
+  * upm::SM130
+
+Wireless Communication:
+  * upm::NRF24l01
+  * upm::NRF8001
+
+Servo/motors:
+  * upm::ES08A
+  * upm::stepmotor
+
+Digital potentiometer
+  * upm::MAX5487
+
 ### Building UPM
 
 See @ref building