FANAP IoT Core Platform

Python implementation of the Fanap IOT Platform.

Requirements

• Python 3 (3.5 is tested)
• MQTT Broker (device data)

Optional

• MongoDB for device-data storage (version 4.0 is tested)
• Postman for evaluating rest-api (version 5.5 and 6.5.3 are tested)

Installation (with virtualenv)

git clone PROJECT_REPOSITORY server

virtualenv env

# In Linux
source env/bin/activate

# In Windows
env\Scripts\activate.bat

cd server
pip install -r requirements.txt

# Set DB/MQTT parameters in run_server.py

python run_server.py

Creating default database!
 * Serving Flask app "app" (lazy loading)
 * Environment: production
   WARNING: Do not use the development server in a production environment.
   Use a production WSGI server instead.
 * Debug mode: on
 * Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)
 * Restarting with stat
 * Debugger is active!
 * Debugger PIN: 324-763-485
 .....

Usage

Postman can be used for evaluating the API. postman_export.json can be used as an example workspace in postman.

Push Device Data

• Post device data (received from MQTT) to the defined URL
• Set ENABLE_PUSHURL environment variable to enable this feature (requires Celery worker and RabbitMQ)
• Define target URL by setting pushURL when adding a new device
• ${DEVICE_ID}, ${DEVICE_NAME},${DEVICETYPE_ID},${DEVICETYPE_NAME} and ${TIMESTAMP} can be used in URL

Software Access

Permanent token for software can be generated (PUT method) or deleted (DELETE method) using HOST/user/software.

Deployment

Example for Docker based deployment is provided. This setup uses PostgreSQL instead of SQLite.

Required tools

• docker (version 18.09.0 is tested)
• docker-compose (version 1.23.2 is tested)

How to run

docker-compose build
docker-compose up