Firepi

A remote web server to control a temperature chamber at Rowan University with a Raspberry Pi sending MODBUS commands.

Setup

Here's how to set up the system:

• Download Python
  • Set up your system environment variables
• Navigate to project folder
• Run pip install -r requirements.txt in a console
• Update app/tempchamber.py to use the correct COM port (see this issue)
• Go to the Google Developer Console
  • Create the API credentials for OAuth. Get the developer id and keys
  • Set up your environment variables
    • See app/settings.py for the variables you need
• Execute python run.py
  • It should appear at 127.0.0.1:5000

API

Firepi uses a RESTful API

Get and put a temperature

/api/v1/temp

• GET
  • {'temp': temp} - Returns the temperature as an integer
• PUT (int newTemp)
  • {'error':'temperature set failure'} - Returns an error if it cannot set the temperature
  • {'response': 'success'} - Returns a success if the temperature was set correctly

Set a temperature curve

The temperature curve is represented on the frontend and backend as a CSV file of 2 columns and n rows. The second column is the length of time in seconds at a temperature given by the first column.

The curve can be set through a POST request containing the CSV data as a string.

/api/v1/tempcurve

• GET
  • {'curve': String} - Returns the original temperature curve in a CSV format
• POST (String csv)
  • {'error':'temperature curve set failure'} - Returns an error if the curve cannot be set
  • {'response': 'success'} - Returns a success if the curve was set correctly

Events

Users can request to use the chamber at certain times using an event system through Google Calendar. This is currently not available.

/api/v1/event

• POST (String user, int start_timestamp, int end_timestamp)

Com Port

The system uses a COM port to connect from the Raspberry Pi to the temperature chamber. The number of the port is not necessarily defined. In order to make it easy to reconnect to a temperature chamber, the frontend will display a connect button if the system is currently disconnected.

Users are able to select a port number and then press a button. This will reset the temperature chamber object and try to reconnect. If it fails, the website will alert you to an error. If this reconnection is successful, the connection dialog will disappear.

/api/v1/reconnect

• PUT (String COM)
  • {'error':'set com failure'} - Returns an error if the connection fails
  • {'response': 'success'} - Returns a success if the connection was set correctly
• GET
  • {'port': n} - Returns some integer n
  • {'error':'get com failure'} - Returns an error if the connection fails