ParticleGeographicLib (community library)

Summary

Name	Value
Name	ParticleGeographicLib
Version	1.0.0
Installs
Author	Zachary Olkin, Charles F. F. Karney
Download	.tar.gz

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.

ParticleGeographicLib

A Particle library for ParticleGeographicLib

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 XYZ hardware, add the ParticleGeographicLib library to your project and follow this simple example:

#include "ParticleGeographicLib.h"
ParticleGeographicLib particleGeographicLib;

void setup() {
particleGeographicLib.begin();
}

void loop() {
particleGeographicLib.process();
}

See the examples folder for more details.

Documentation

TODO: Describe ParticleGeographicLib

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 ParticleGeographicLib_myname to add the library to a project on your machine or add the ParticleGeographicLib_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