tempestas

A REST API for processing sensor.community data
git clone https://git.bracken.jp/tempestas.git
Log | Files | Refs | README | LICENSE

README.md (1187B)

      1 Tempestas
      2 =========
      3 
      4 A small HTTP server backed by a PostgreSQL database for collecting and
      5 displaying data from [sensor.community][sc] devices running the AirRohr
      6 firmware.
      7 
      8 
      9 UI
     10 --
     11 
     12 `/dashboard/`: HTTP GET endpoint for viewing charts of temperature, humidity,
     13 pressure, and particulate matter across all sensors.
     14 
     15 
     16 API Endpoints
     17 -------------
     18 
     19 `/sensor/airrohr/`: HTTP endpoint for submitting AirRohr formatted POST
     20 requests.
     21 
     22 `/sensor/reading/$sensorID/$readingType`: HTTP GET endpoint for retrieving
     23 JSON-formatted data for the specified sensor and reading type.
     24 
     25 `/sensor/sensors/`: HTTP GET endpoint for retrieving a JSON-formatted list of
     26 sensors.
     27 
     28 
     29 Building and running
     30 --------------------
     31 
     32 To build and run the binary:
     33 
     34     go build
     35     ./tempestas
     36 
     37 Options:
     38   -db        the tempestas database name (default: 'tempestas')
     39   -user      the database user (default: 'tempestas')
     40   -password  the database password (default: '')
     41   -address   the host:port on which to host the service (default: ':8080')
     42   -assets    the HTTP asset directory (default: '/usr/local/share/tempestas/www')
     43   -devdb     use an empty database for serving up UI code only
     44 
     45 [sc]: https://sensor.community