FastIoT Framework

Welcome to FastIoT’s documentation.

FastIoT is a framework for rapid development of IIoT-Systems using Python as main programming language. It helps to set up a micro-service architecture and create services. The development has been started as basis for various research projects at Fraunhofer IVV, Dresden, Germany.

To get started quickly it is equipped with a powerful command line interface (CLI): fiot. This helps setting up a new project, create new services and run tests. It also supports creating cross-architecture Docker-containers and deployment configurations with docker-compose files and Ansible playbooks to bring the software to the systems they belong. Run fiot --help for a full list of features.

As for now the overall framework has only been used and tested on Linux systems.

If you use this framework in your scientific projects please cite:

Tilman Klaeger, Konstantin Merker, “FastIoT – A Holistic Approach for Rapid Development of IIoT Systems”, 2022. https://doi.org/10.48550/arXiv.2201.13243.

Framework architecture and quickstart

• Architecture Overview
• Quick start
• Project structure
• FastIoT Taxonomy

Tutorials

• Part 1: Getting started
  • Setting up your first FastIoT Project
  • Setting up PyCharm for development
  • fiot CLI Introduction - Generating config files, building Docker containers
  • Running unit and integration tests
• Part 2: Building services
  • Building Services
  • Service Entry Point - run.py
  • Service Logic
  • Publish, subscribe, request and reply in your service
  • Configuration for a service
  • Database Services
• Part 3: Config management
  • Project configuration using configure.py
  • Deployment configuration - deployment.yaml
  • Service Manifest - manifest.yaml
  • Managing dependencies
• Part 4: Specific topics
  • Creating your own data types
  • Adding custom infrastructure services to your project
  • Debugging message flow between services
  • Adapting the build system to your local infrastructure
  • Customized logging
  • Some notes on working with TCP ports

Services

Please have a look at the API documentation for core services to provide basic functionality and for example services. Those will provide you with basic ideas how to do integration tasks and develop you own services.

• fastiot_core_services

• fastiot_sample_services

API Reference

• FastIoT Library (fastiot)
• FastIoT Core Services (fastiot_core_services)
• FastIoT Sample Services (fastiot_sample_services)

Indices and tables

• Index

• Module Index

• Search Page