Sigfox Platform

by luisomoreau

GitHub Readme.md

Sigfox Platform

Warning: Project under active development, do not use it for production!

About this project

This project is a cloud platform to manage and visualize Sigfox devices and messages.

Get started

Demo

Try it now with Heroku

Deploy an instance on your Heroku account to play around with it!

Warning: When using the free plan, the application goes to sleep after 30 min of inactivity (checkout the pricing).

Deploy

An alternative way to get it running at Heroku is to install the Heroku Toolbelt and follow these steps:

git clone https://github.com/luisomoreau/sigfox-platform.git my-project
cd my-project
heroku apps:create my-project
git push heroku master

If you are not familiar with Heroku, just create an account an follow the procedure:

  1. Create a new app:

create app

  1. Build & deploy app:

build app

  1. (Optional) Link the application with a MongoDB MLab database (Free):

Note that if you don't link a database to your application, all the data will be erased every time the application restarts.

  • Go to https://mlab.com and create an account and login.

  • Create a new MongoDB Deployments:

mlab-select-service

  • Select your plan:

mlab-select-plan

  • Select your region:

mlab-select-region

  • Create database:

mlab-create-db

  • Validate:

mlab-validate

  • Create database user:

mlab-create-user

  • Copy your MongoDB URI :

mlab-view-user

  • Go back to your Heroku Dashboard and go to the Settings tab:

heroku-show-env-variables

  • Click on Reveal Config Vars and add your MongoDB URI:

heroku-add-MONGODB_URI

  • Restart all dynos:

heroku-restart-dynos

User guide

  • Open app and register:

login

register

Note that, the first user to register will be granted an admin role. The other users to register will be granted user roles.

Development

This project uses Loopback 3, Angular 4, Fireloop and MongoDB.

Requirements

API

Below is the functional/sequential diagram representing the message journey.

message_journey

Webapp

Color code

GPS Sigfox WiFi BLE #9B7A48 #9B7A48 #792FAA #792FAA #2F2A30 #2F2A30 #3C58CE #3C58CE

Developers

Linking a Sigfox device to the platform

Once the application is deployed, head over to the 'connectors'. You will need to create a developer access token in order to secure the API calls. You can then copy & paste the callback information you need in the device type new callback onto the Sigfox Backend.

Adding a custom parser

A short wiki can be found here.

Roadmap

Authors

Contributors

Feel free to submit a Pull Request and don't forget to add you name and your useful links ;)

Made with  ❤️  by Antoine de Chassey & Louis Moreau