prosumer.rst 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. .. _prosumer:
  2. Prosumer
  3. ========
  4. A Prosumer owns a number of energy consuming or producing assets behind a connection to the electricity grid.
  5. A Prosumer can access the following services:
  6. - *postMeterData* :ref:`(example) <post_meter_data_prosumer>`
  7. - *postPrognosis* :ref:`(example) <post_prognosis_prosumer>`
  8. - *getMeterData* :ref:`(example) <get_meter_data_prosumer>`
  9. - *getPrognosis* :ref:`(example) <get_prognosis_prosumer>`
  10. - *postUdiEvent* :ref:`(example) <post_udi_event_prosumer>`
  11. - *getDeviceMessage* :ref:`(example) <get_device_message_prosumer>`
  12. .. _post_meter_data_prosumer:
  13. Post meter data
  14. ---------------
  15. .. autoflask:: flexmeasures.app:create(env="documentation")
  16. :endpoints: flexmeasures_api_v1_1.post_meter_data
  17. .. _post_prognosis_prosumer:
  18. Post prognosis
  19. --------------
  20. .. autoflask:: flexmeasures.app:create(env="documentation")
  21. :endpoints: flexmeasures_api_v1_1.post_prognosis
  22. .. _get_meter_data_prosumer:
  23. Get meter data
  24. --------------
  25. A Prosumer can query the FlexMeasures web service for its own meter data using the *getMeterData* service.
  26. .. autoflask:: flexmeasures.app:create(env="documentation")
  27. :endpoints: flexmeasures_api_v1_1.get_meter_data
  28. .. _get_prognosis_prosumer:
  29. Get prognosis
  30. -------------
  31. A Prosumer can query the FlexMeasures web service for prognoses of its own meter data using the *getPrognosis* service.
  32. .. autoflask:: flexmeasures.app:create(env="documentation")
  33. :endpoints: flexmeasures_api_v1_1.get_prognosis
  34. .. _post_udi_event_prosumer:
  35. Post UDI event
  36. --------------
  37. A Prosumer can post its flexibility constraints to the FlexMeasures web service as UDI events using the *postUdiEvent* service.
  38. .. autoflask:: flexmeasures.app:create(env="documentation")
  39. :endpoints: flexmeasures_api_v1_2.post_udi_event
  40. .. _get_device_message_prosumer:
  41. Get device message
  42. ------------------
  43. A Prosumer can query the FlexMeasures web service for control signals using the *getDeviceMessage* service.
  44. .. autoflask:: flexmeasures.app:create(env="documentation")
  45. :endpoints: flexmeasures_api_v1_2.get_device_message