Integrated Computer

Getting Started

1. Install Python3 - https://www.python.org/downloads/
2. Download pip (Google instructions per OS)
3. python3 -m venv venv to create a virtual environment. This is used to manage Python dependencies within just the context of your terminal instance.
4. source venv/bin/activate to start your virtual environment
5. pip install -r requirements.txt to install all project dependencies
6. FLASK_ENV=development flask run --no-reload to run the server in your terminal. The server will live update as you make code changes.
7. If the above command does not work, try: python3 wsgi.py

Resources and Documentation

1. API Docs:
   1. Measurement Schema
   2. Meta State Schema
   3. Routine Schema
   4. State Schema
   5. Task Queue Schema
2. Sensor and Actuator Source of Truth
3. Original API Definition
4. Flask Documentation

Note on the Project Structure

The project has been designed to follow the pattern of dependency injection. Each layer has its dependencies injected in the app.py file to limit coupling between components.

Testing

Using the APIs below, routines can be manually test run, and sensor values can be manually set to test the state machine.