1
1
<p align =" center " >
2
- <img src =" https://github.com/intel-iot-devkit /upm/blob/master/docs/icons/upm_logo.png " height =" 150px " width =" auto " algt =" UPM Logo " />
2
+ <img src =" https://github.com/eclipse /upm/blob/master/docs/icons/upm_logo.png " height =" 150px " width =" auto " algt =" UPM Logo " />
3
3
</p >
4
4
5
- Eclipse UPM Sensor/Actuator Repository for Eclipse MRAA
5
+ Eclipse UPM Sensor and Actuator Repository
6
6
==============
7
7
8
8
The Eclipse UPM repository provides software drivers for a wide variety of
9
9
commonly used sensors and actuators. These software drivers interact with the
10
10
underlying hardware platform (or microcontroller), as well as with the attached
11
- sensors, through calls to [ MRAA] ( https://github.com/intel-iot-devkit /mraa ) APIs.
11
+ sensors, through calls to [ Eclipse MRAA] ( https://github.com/eclipse /mraa ) APIs.
12
12
13
- Programmers can access the interfaces for each sensor by including the sensor’ s
13
+ Programmers can access the interfaces for each sensor by including the sensor' s
14
14
corresponding header file and instantiating the associated sensor class. In the
15
15
typical use case, a constructor initializes the sensor based on parameters that
16
16
identify the sensor, the I/O protocol used and the pin location of the sensor.
@@ -19,12 +19,14 @@ overloaded constructors that accept string identifiers.
19
19
20
20
We endorse additions that implement the generic C and C++ interfaces provided
21
21
with the libraries. With the 2.0 release, UPM introduces the following sensor
22
- interfaces: iAcceleration, iAngle, iButton, iClock, iCollision, iDistance,
22
+ interfaces:
23
+ ```
24
+ iAcceleration, iAngle, iButton, iClock, iCollision, iDistance,
23
25
iDistanceInterrupter, iEC, iElectromagnet, iEmg, iGas, iGps, iGyroscope,
24
26
iHallEffect, iHeartRate, iHumidity, iLight, iLineFinder, iMagnetometer,
25
27
iMoisture, iMotion, iOrp, iPH, iPressure, iProximity, iTemperature, iVDiv,
26
28
iWater.
27
-
29
+ ```
28
30
The developer community is invited to propose new interfaces for actuator types.
29
31
30
32
The UPM project is joining the Eclipse Foundation as an Eclipse IoT project.
@@ -61,27 +63,21 @@ A sensor/actuator is expected to work as such (here is the MMA7660 accelerometer
61
63
}
62
64
```
63
65
64
- Browse through the list of all [examples](https://github.com/intel-iot-devkit /upm/tree/master/examples).
66
+ Browse through the list of all [examples](https://github.com/eclipse /upm/tree/master/examples).
65
67
66
- Multi-sensor samples for the starter and specialized kits can be found in the
68
+ Multi-sensor samples for starter and specialized kits can be found in the
67
69
[iot-devkit-samples](https://github.com/intel-iot-devkit/iot-devkit-samples) repository.
68
70
69
71
### Supported Sensors
70
72
71
73
Supported [sensor list](http://iotdk.intel.com/docs/master/upm/modules.html) from API documentation.
72
74
73
- You can also refer to the [Intel® IoT Developer Zone](https://software.intel.com/iot/hardware/sensors).
74
-
75
- ### IDE Support
75
+ ### IDE Support and More
76
76
77
- The UPM sensor libraries are directly supported by the IDEs listed on the Intel®
78
- Developer Zone Tools & IDEs page.
79
-
80
- <a href="https://software.intel.com/iot/tools"><img src="docs/icons/iss.png"/></a>
81
-
82
- Intel® System Studio integration offers IoT specific features such as a sensor explorer,
83
- library sync tools and the ability to easily import existing projects and samples that
84
- use the UPM libraries. For further details please refer to the IoT User Guides on IDZ.
77
+ The UPM project includes support for multiple industrial-grade sensors, actuators, radios,
78
+ protocols and standards in use today. It is also highly integrated with the Eclipse IDE
79
+ through the help of the Foundation's partners.
80
+ Learn more about [tools](https://software.intel.com/en-us/tools-by-segment/systems-iot).
85
81
86
82
### Installing UPM
87
83
@@ -92,38 +88,24 @@ Find notes on how to install UPM on various OS'es on this [page](docs/installing
92
88
See building documentation [here](docs/building.md).
93
89
94
90
[](https://travis-ci.org/intel-iot-devkit/upm)
95
-
96
- ### Making your own UPM module
97
-
98
- A quick way to add a new sensor driver is to port existing code from another
99
- platform (e.g. Arduino) and swap the IO calls to the MRAA API. This of course
100
- assumes either ownership of the original code or a MIT compatible license that
101
- allows unrestricted redistribution.
102
-
103
- The [porting](docs/porting.md) section has more information on this process,
104
- and there is an example available based on the max31855 [sensor](docs/max31855.md).
105
-
106
- We have an [on demand webinar](https://software.seek.intel.com/IoT_WebinarSeries_Reg)
107
- available that covers using an IDE to develop for the UPM project along with other
108
- considerations for new contributions.
109
-
110
- Read more on creating Java [bindings](docs/creating_java_bindings.md) for your
111
- new driver.
91
+ [](https://sonarcloud.io/dashboard?id=upm-master)
112
92
113
93
### Guidelines and rules for new UPM contributions
114
94
115
95
Before you begin development, take a look at our naming [conventions](docs/naming.md).
116
96
The name you pick for a newly added sensor needs to be unique in the UPM library.
117
97
118
- Then, please go over this short set of rules for new [contributions](docs/contributions.md).
98
+ Next, review the project's [contribution guide](docs/contributions.md).
99
+
119
100
Make sure you add yourself as an author on every new code file submitted.
120
101
If you are providing a fix with significant changes, feel free to add yourself
121
- as a contributor. Signing-off your commits is mandatory and acts as an
122
- acknowledgment of the committer agreement .
102
+ as a contributor. Signing-off your commits and accepting the ECA is mandatory
103
+ for making new contributions to this project .
123
104
124
105
Documenting your code is also a big part of the task. We have a strict set of
125
106
tags used to classify our sensors and their capabilities. You can find out more
126
107
about this in our [section](docs/documentation.md) on documenting a sensor API.
108
+
127
109
Finally, if you really want to ensure consistency with the rest of the library,
128
110
and the intel-iot-devkit repositories in general, take a look at our extensive
129
111
[author guide](docs/guidelines.md).
0 commit comments