Flip Energy API
    Flip Energy API
    • Overview
    • Important concepts
    • Authentication
    • Enrollment process
    • End-user app design
    • Monitoring / Telemetry
    • Control
    • Change log
    • Mobile App API
      • Devices
        • Create Device
        • Read Devices
        • Read Device
        • Update Device
        • Delete Device
      • Enrollments
        • Create Enrollment
        • Read Enrollments
        • Read Enrollment
        • Delete Enrollment
      • Events
        • Read Events
        • Read Event
        • Update Event Participation
      • Programs
        • Read Programs
        • Read Program
      • Sites
        • Read Site
        • Update Site
    • Cloud API
      • Sites
        • Get Site Token
        • Get Sites
      • Commissioning
        • Commission Site And Devices
      • Sessions
        • Sessions
      • Commands
        • Command Created
        • Update Command Status
      • Programs
        • Read Programs
      • Telemetry
        • Report Battery Telemetry
      • Webhooks
        • Overview
        • List of events
        • Webhook headers
        • Schemas
          • Command
          • Enrollment
          • Event

    Monitoring / Telemetry

    The monitoring and control flow happens entirely in the background, from your cloud to Flip's cloud.

    Telemetry#

    Programs have various telemetry requirements, but for simplicity's sake we merged them into a single interface, and expect all of this data to be uploaded to our servers at no less than 5 minute intervals, for each device. You may send data at faster intervals if desired.
    💡
    Some programs require 30 days of data prior to enrollment. For this reason, and in order to speed up enrollment, we recommend sharing telemetry even for devices that are not actively enrolled.
    To send telemetry data, use the POST /v1/telemetry endpoint. This endpoint allows you to send telemetry in batches if you so desire. More information available on the endpoint page.
    Depending on your system's capabilities, we may also be able to fetch this information from your servers every 5 minutes, or we may open up a Kafka or MQTT messaging queue.
    Modified at 2024-04-30 15:18:17
    Previous
    End-user app design
    Next
    Control
    Built with