Welcome to UPM Node.JS Documentation!
+ + +Browse to a module or class using the sidebar to view its API + documentation.
+ +UPM is a high level repository for sensors that use libmraa. 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 instantiated.
+ +The constructor is expected to initialise the sensor and + parameters may be used to provide identification/pin location on the + board.
+ +Typically an update() function will be called in order to get new + data from the sensor in order to reduce load when doing multiple + reads to sensor data.
+ +Making + your own + UPM Module*
+ + +This + link + has more information on making a new UPM module.
+ +There is also an example available for max31855 + sensor.
+ +Naming + Conventions and + Rules for + New UPM + Contributions*
+ + +Before you begin development, please take a look at our naming + conventions.
+ + +Also, please read the guidelines for contributions to + UPM.
+ + +Don’t forget to check the documentation + section.
+ +Note
+-
+
- Make sure you add yourself as an author on every new + code file submitted. +
- If you are providing a fix with significant changes, + feel free to add yourself as a contributor. +
- Signing-off your commits is mandatory. +
Keyboard + Shortcuts*
+ +-
+
-
+
+
Press s to focus the API search box.
+ -
+
+
Use Up and Down to select classes, + modules, and search results.
+ -
+
+
With the API search box or sidebar focused, use ⌘-Left + or ⌘-Right to switch + sidebar tabs.
+ -
+
+
With the API search box or sidebar focused, use Ctrl+Left + and Ctrl+Right to switch sidebar tabs.
+