• Scope of Work
• Dependencies
• Instructions for Use
  • Setup
  • Teardown
• API Reference
  • Setting Rules
    • Examples
  • Getting Rules
    • Examples
  • Pushing Sensor Data
    • Examples
• Future Work

• Docker daemon installed on local machine
• You have a Twilio account

• Clone this repo to your machine
• Copy flask/constants_example.json to flask/constants.json
• Modify flask/constants.json to your values of account_phone, account_sid, auth_token, and tgt_phone (the phone you want to set text messages to when there is an alert).
  • Do not change any values within the pg section of constants.json
• Move into the root directory of the cloned repository

A sensor must have rules set before it can have data posted to it. To set rules, call the /setrule endpoint with the following JSON:

Note: The below example assumes a flask api IP address of 172.19.0.3:

>>> import requests
>>> res = requests.post('http://172.19.0.3:80/setrule', json={"id":"sensor12345", "unit":1, "logic":0, "temph": 32})

If the call is successful, you should show the following response code and body:

>>> res.status_code
200

>>> res.content
b'{"id": "sensor12345", "unit": 1, "logic": 0, "templ": 32.0, "temph": ""}'

Assuming you have already set a rule for a sensor using the /setrule route, you may query the database for existing rules. These rules may not be updated once they have been created.

Note: The below example assumes a flask api IP address of 172.19.0.3:

>>> import requests
>>> res = requests.get('http://172.19.0.3:80/getrule', json={"id": "sensor12345"})

If the call is successful, you should show the following response code and body:

>>> res.status_code
200

>>> res.content
b'{"logic": 0, "unit": "farenheit", "templ": "32.0", "temph": "None"}

Assuming you have already set a rule for a sensor using the /setrule route, you may push sensor updates to that previously configured sensor id through the updates route, hosted at /.

Temperature conversions between rules and input data are conducted automatically. In other words, a sensor can be created with rules in Fahrenheit, and updated at the / route with units of Celsius. This does not affect the operation of the utility. Note that the default response unit from the api is in Celsius for simplicity.

Note: The below example assumes a flask api IP address of 172.19.0.3:

>>> import requests
>>> res = requests.post('http://172.19.0.3:80', json={"id":"sensor12345", "value": 19, "unit": 1})

Note that in the docker daemon logs, you should see debug output similar to the following:

web_1  | compare temps are:  {'logic': 0, 'unit': 1, 'templ': Decimal('32.0'), 'temph': None, 's_value': 19.0, 's_unit': 1, 'id': 'sensor12345'} 0 32.0 None 19.0 1
web_1  | logic0, temp under lower lim
web_1  | SM232XXXXXXXXXXXXXXXXXXXXXXXXXXXXX

The last line is the identifier of the text message sent to the mobile phone. This could be logged in the database with a few code changes if needed. It could also be caught with a logger on the daemon.

Text messages will be presented to a mobile device similar to the following:

To stop the service, run docker-compose stop && docker-compose rm -f from the root directory of the cloned repository.

• Unit tests
• Integration tests
• Host dependendency installation scripts
• Making my code suck less in general