waterloop / goose-sensors-wio

Wio packages for the sensors used on Goose pods

Goose Sensors

This repository contains code for all the sensors used on Waterloop's Goose Hyperloop pods.

Sensor code is for AVR platform and is written using Cosa SDK. All of the sensors in this repo are wio packages. This allows for each sensor to be included as a dependendency in another wio projects.

Contributing

Development of sensor code requires:

• cmake
• avr-gcc (linux and macOS) or Arduino SDK (Windows)
• wio

To learn more about wio, visit it's github page. There is a detailed tutorial on how to get the tool and all the toolchain files to get started with AVR development.

master branch is protected by default and will not accept any commits. You will have to fork the repo and make Pull Request to the master branch. This will then be reviewed and handled accordingly.

Create a wio package inside the repository and put all the code for that specific sensor there. include directory will contain all the public headers and src directory will contain rest of the code. You are required to write a test in tests directory. Your package is automatically included by wio as a dependency when you are testing and you can call the package just how others will call it when they will include this sensor as a dependency.

goose-sensors-wio's Issues

Update the code base for wio 2.0

• url is replaced with repository

  • In terms of what to add for repository, it should be the url of each sensor. ex: https://github.com/waterloop/goose-sensors-wio/tree/master/bsi0007-tilt-sensor

• pkg_compile_flags added

• Dmytro remove yourself from contributors because you are already an author

• For the author field, add more information so you can be linked to the project properly:

  • https://docs.npmjs.com/files/package.json#people-fields-author-contributors
  • Make it one line like:
    "Deep Dhillon <[email protected]> (http://github.com/dhillondeep)"

Sensor class names

Right now sensor header names are very generic. Example:

#include <TemperatureSensor.h>

We should rename the sensor header names with more specific names. Example:

#include <TMP36.h>

The reason for this is that we could have multiple types of temperature sensors and the include paths will clash.

We should also consider having a directory inside include directory with the name sensor or something else (we can choose). All the headers will go inside that directory. This way when including headers, it will look like:

#include <sensor/TMP36.h>

or even something like:

#include <temperature/TMP36.h>

Needs a travis build