Logo
  • Getting started
  • Get in touch
  • FlexMeasures Changelog

Features

  • Scheduling
  • Forecasting
  • Reporting

Tutorials

  • Toy example: Introduction and setup
  • Toy example I: Scheduling a battery, from scratch
  • Toy example II: Adding solar production, and a limit on the grid connection
  • Toy example III: PV curtailment an Multi-asset scheduling
  • A flex-modeling tutorial for storage: Vehicle-to-grid
  • Toy example IV: Computing schedules for processes
  • Toy example V: Computing reports
  • Posting data
  • Forecasting & scheduling
  • Building custom UIs

Concepts

  • Energy flexibility
  • The FlexMeasures data model
  • Security aspects
  • Storage device scheduler: Linear model

The in-built UI

  • Dashboard
  • Assets
  • Sensors
  • Account overview
  • Administration

The API

  • API Introduction
  • Notation
  • Version 3.0
  • Developer API
  • API change log

The CLI

  • CLI Commands
  • FlexMeasures CLI Changelog

Hosting FlexMeasures

  • Installation & First steps
  • Running via Docker
  • Postgres database
  • How to deploy FlexMeasures
  • Configuration
  • White-labeling FlexMeasures
  • Redis Queues
  • Error monitoring
  • Modes

Developing Plugins

  • Writing Plugins
  • Plugin showcase
  • Plugin Customization

Developing on FlexMeasures

  • Why FlexMeasures adds value for software developers
  • Developing for FlexMeasures
  • Running a complete stack with docker-compose
  • Continuous integration
  • Custom authorization
  • Dependency Management
  • Developing on the API
  • Automate deployment via Github actions and Git

Code Documentation

  • flexmeasures.api
    • flexmeasures.api.common
      • flexmeasures.api.common.implementations
      • flexmeasures.api.common.responses
      • flexmeasures.api.common.routes
      • flexmeasures.api.common.schemas
        • flexmeasures.api.common.schemas.assets
        • flexmeasures.api.common.schemas.generic_assets
        • flexmeasures.api.common.schemas.generic_schemas
        • flexmeasures.api.common.schemas.search
        • flexmeasures.api.common.schemas.sensor_data
        • flexmeasures.api.common.schemas.sensors
        • flexmeasures.api.common.schemas.users
        • flexmeasures.api.common.schemas.utils
      • flexmeasures.api.common.utils
      • register_at()
    • flexmeasures.api.dev
    • flexmeasures.api.sunset
    • flexmeasures.api.v3_0
    • get_versions()
    • register_at()
    • request_auth_token()
  • flexmeasures.app
  • flexmeasures.auth
  • flexmeasures.cli
  • flexmeasures.data
  • flexmeasures.ui
  • flexmeasures.utils
FlexMeasures
  • flexmeasures.api
  • flexmeasures.api.common
  • flexmeasures.api.common.schemas
  • View page source

flexmeasures.api.common.schemas

Modules

flexmeasures.api.common.schemas.assets

flexmeasures.api.common.schemas.generic_assets

flexmeasures.api.common.schemas.generic_schemas

flexmeasures.api.common.schemas.search

flexmeasures.api.common.schemas.sensor_data

flexmeasures.api.common.schemas.sensors

flexmeasures.api.common.schemas.users

flexmeasures.api.common.schemas.utils

Previous Next

© Copyright 2025, Seita Energy Flexibility, developed in partnership with A1 Engineering, South Korea.

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