Ver código fonte

README: Added overview of C++ interfaces

Signed-off-by: Henry Bruce <henry.bruce@intel.com>
Signed-off-by: Abhishek Malik <abhishek.malik@intel.com>
Henry Bruce 9 anos atrás
pai
commit
f35f6cc064
1 arquivos alterados com 14 adições e 5 exclusões
  1. 14
    5
      README.md

+ 14
- 5
README.md Ver arquivo

@@ -12,6 +12,19 @@ to provide identification/pin location on the board.
12 12
 Typically an update() function will be called in order to get new data from the
13 13
 sensor in order to reduce load when doing multiple reads to sensor data.
14 14
 
15
+Although implementation and API design is up to the developer, C++ interfaces have
16
+been defined for the following sensor/actuator types and developers are encouraged to
17
+implement them. Interface header files are in the src/upm folder.
18
+
19
+* Light controller 
20
+* Light sensor
21
+* Temperature sensor
22
+* Humidity sensor
23
+* Pressure sensor
24
+* Analog to digital converter
25
+
26
+Feedback on interface design and additions for new types are welcome
27
+
15 28
 ### Example
16 29
 
17 30
 A sensor/actuator is expected to work as such (here is the MMA7660 accelerometer API):
@@ -51,10 +64,6 @@ A sensor/actuator is expected to work as such (here is the MMA7660 accelerometer
51 64
     }
52 65
 ```
53 66
 
54
-However implementation and API design is completely up to the developer, some
55
-enumerable sensors for example may provide much clever instantiation. Displays
56
-may also create more complex structures in order to interface with them.
57
-
58 67
 Browse through the list of all [examples](https://github.com/intel-iot-devkit/upm/tree/master/examples).
59 68
 
60 69
 Multi-sensor samples for the starter and specialized kits can be found in the
@@ -81,7 +90,7 @@ See building documentation [here](docs/building.md).
81 90
 
82 91
 Porting [link](docs/porting.md) has more information on making new UPM modules.
83 92
 
84
-There is also an example available for max31855 [sensor](docs/max31855.md).
93
+There is also an example available gfor max31855 [sensor](docs/max31855.md).
85 94
 
86 95
 Guide on creating Java [bindings](docs/creating_java_bindings.md).
87 96