icoapi
  • Requirements
  • Installation & Setup
  • Usage
  • Configuration
  • Value Conversion
  • Development
icoapi
  • ICOapi
  • View page source

ICOapi

A REST and WebSocket API using the Python FastAPI library.

When the API is running, it hosts an OpenAPI compliant documentation under /docs, e.g. under localhost:33215/docs.

  • Requirements
    • Software
    • Hardware
  • Installation & Setup
    • Manual Install
      • PyPI
      • Repository
    • System Service Installation (Linux)
    • Docker (Linux)
  • Usage
    • Get List of Available Sensor Devices
    • Connect to Available Sensor Device
    • Check if the STU is Connected to the Sensor Device
    • Disconnect from Sensor Device
  • Configuration
    • Environment Variables
      • Client/API Connection Settings
      • File Storage Settings
      • Logging Settings
    • Configuration Files
      • Configuration File Header
      • Sensor Configuration
      • Metadata
      • Dataspace
  • Value Conversion
    • Step 1: 16-bit ADC Value to Voltage
    • Step 2: Voltage to Physical Value
  • Development
    • Tests
    • Guidelines
      • Logging
      • Release
Next

© Copyright 2026, Moritz Breurather and René Schwaiger.

Built with Sphinx using a theme provided by Read the Docs.