Skip to content
Monash Human Power - Data Aquisition System Web Server.
JavaScript HTML Python CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
client
server
.all-contributorsrc
.editorconfig
.eslintignore
.eslintrc.js
.gitignore
.prettierrc
.travis.yml
Procfile
README.md
gulpfile.js
package-lock.json
package.json

README.md

Monash Human Power - Data Acquisition System Web Server

All Contributors

Codacy Badge Build Status

A web server for the Data Acquisition System (DAS) for Monash Human Power.

The node.js + Express HTTP REST server is used to host the real-time dashboard whilst the MQTT broker is used to transfer data from the sensors to all the necessary scripts that need it.

Getting Started

Environment variable setup

Set up environment variables using a .env file. Create a .env file at the root of this project. Add the following variables:

Environment Variable Description
MQTT_USERNAME MQTT username
MQTT_PASSWORD MQTT password
MQTT_SERVER Address of the MQTT broker
MQTT_PORT Port of the MQTT broker
HEROKU Define this only if you are the Heroku instance

Installation guide

  1. npm install to install all dependencies and libraries
  2. npm run build when it's your first time running the application
  3. npm run start to start the server

Documentation

Endpoint Method Body Description
/files GET Returns an array of files that are stored on the server
/files/recent GET Download most recent file edited from server
/files/filename GET Download specified file from server
/files/filename DELETE Delete specified file from server
/server/status GET Status of the server

TODO

  • Add Map display
  • Add power model graph/output
  • Options page that saves options to browser storage

Contributors

Thanks goes to these wonderful people (emoji key):

Angus Lee
Angus Lee

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

You can’t perform that action at this time.