teleceptor

Data collection web application for microcontrollers


License
GPL-3.0
Install
pip install teleceptor==0.7.7

Documentation

Teleceptor

2014 Visgence Inc.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>

Design Goals

Getting Started (Ubuntu and Raspberry Pi)

Dependencies

jinja2
sqlalchemy
whisper
pip
cherrypy (pip install --no-use-wheel cherrypy on windows)
requests

Setting Up Teleceptor

  1. Pull the latest version of Teleceptor from GitHub.
  2. To insatll a local config customizable first run ./teleceptor copyconfig app will print path
  3. In teleceptor folder, run command ./teleceptorcmd setup and wait until Done! is printed.
    • Note: All commands should be run in the teleceptor folder unless installed with pip or setuptools
  4. Run command ./teleceptorcmd runserver. You will now be running teleceptor as a local host.
  5. Open up either a Chrome or Mozilla Firefox browser and go to page http://0.0.0.0:8000/
    • If you do not have any sensors connected, you should see two default sensors producing a graph per tab with random data.
  6. Set up desired sensors and start collecting data.(See below for setting up sensors)

Setting Up Sensors

  1. Run command ./teleceptorcmd poller. This will begin to look for sensors via USB ports.
  2. Plug in your sensor through a USB port.
    • Make sure you have the most current firmware for your sensor. (See Sensor Firmware.)

Sensor Firmware

Sensor firmware can be found in the firmware folder. Download the appropriate firmware for your type of sensor, and then upload it to your sensor.

Important:

  • You will need to download aJSON and add it to your adruino IDE.
  • In the .ino file that you download for your firmware, change the uuid found in static const char jsonData[ ] to be a unique name of your choosing.

Teleceptor Front-End Usage

  • To view sensor data that has been collected, click on a sensor under the Sensors tab.
  • To look at a certain time period of data, select a range under the Time Controls tab.
    • Specifc data can also be viewed by passing the mouse on the graph to observe data points and the time it was collected.
    • 🌟 By clicking and dragging on a certain part of either graph, you can zoom-in on points.
  • Some information about the sensor is editable and will change the graph accordingly such as Units or Calibration.
    • Be sure to save after editing for the configuration information to be available later.
    • Metadata cannot be changed. However, you can change it in the firmware and then re-upload the firmware to the sensor.
  • If you download updates from teleceptor but and are not sure if the webpage is up-to-date as well, clear your web browser's cache:
    • Chrome: Right-click in a blank spot on the page -> Inspect element -> Settings (gear symbol) -> Disable cache (while DevTools is open) -> Refresh the page
    • Mozilla Firefox: ctrl+Shift+R will reload the page without cache and/or ctrl+Shift+Delete -> Details -> Cache checkbox -> Clear Now