NimbleSensor (community library)

Summary

Name	Value
Name	NimbleSensor
Version	0.0.10
Installs	676
Author	Ryan Kastr.kast4321@gmail.com
Download	.tar.gz
All Versions	0.0.10, 0.0.9, 0.0.8, 0.0.7, 0.0.6, 0.0.5, 0.0.4, 0.0.3, 0.0.2

A library to handle basic sensors which map a min/max bit to a min/max reading

Example Build Testing

Device OS Version:

This table is generated from an automated build. Success only indicates that the code compiled successfully.

Library Read Me

This content is provided by the library maintainer and has not been validated or approved.

Sensor

A Particle library for Sensor

Welcome to your library!

To get started, modify the sources in src. Rename the example folder inside examples to a more meaningful name and add additional examples in separate folders.

To compile your example you can use particle compile examples/usage command in Particle CLI or use our Desktop IDE.

Libraries can also depend on other libraries. To add a dependency use particle library add or library management in Desktop IDE.

After the library is done you can upload it with particle library upload or Upload command in the IDE. This will create a private (only visible by you) library that you can use in other projects. If you wish to make your library public, use particle library publish or Publish command.

TODO: update this README

Usage

Connect sensor hardware, add the Sensor library to your project and follow this simple example:

#include "Sensor.h"
#include <string>

// Initialize objects from the lib
//define current sensor variables
const unsigned int sensorPin = A1;
const unsigned int minBit = 0;
const unsigned int maxBit = 4095;
const double minReading = 0.0;
const double maxReading = 100.0;
Sensor sensor = Sensor(sensorPin, minBit, maxBit, minReading, maxReading);

void setup() {
// Call functions on initialized library objects that require hardware
Serial.begin(9600);
sensor.begin();
}

void loop() {
// Use the library's initialized objects and functions
double currentReading = sensor.getReading();
int currentRaw = sensor.getRaw();
Serial.println("Current Reading is: " + String(currentReading));
Serial.println("Current Raw Reading is: " + String(currentRaw));
}

See the examples folder for more details.

Documentation

TODO: Describe Sensor

Contributing

Here's how you can make changes to this library and eventually contribute those changes back.

To get started, clone the library from GitHub to your local machine.

Change the name of the library in library.properties to something different. You can add your name at then end.

Modify the sources in and with the new behavior.

To compile an example, use particle compile examples/usage command in Particle CLI or use our Desktop IDE.

After your changes are done you can upload them with particle library upload or Upload command in the IDE. This will create a private (only visible by you) library that you can use in other projects. Do particle library add Sensor_myname to add the library to a project on your machine or add the Sensor_myname library to a project on the Web IDE or Desktop IDE.

At this point, you can create a GitHub pull request with your changes to the original library.

If you wish to make your library public, use particle library publish or Publish command.

LICENSE

Licensed under the license