GET: list all devices
Returns: array of devices

curl --request GET --url http://localhost:3000/device 

POST: create a new device
name: String -> Name of the device
consumption: integer -> How much the device consumes in kWh
duration: null/integer -> how long the device runs for in seconds (null = forever)

Returns: the device created

curl --request POST \
    --url http://localhost:3000/device \
    --header 'Content-Type: application/json' \
    --data '{
        "name": "crypto farm",
        "consumption": 99999,
        "duration": null
    }'

• /:device_id or /:device_name

  • GET: Return a specific device
    Returns: the device

    curl --request GET --url http://localhost:3000/device/1
    curl --request GET --url http://localhost:3000/device/device%201
    

  • PATCH: Update a device
    Same keys as POST /device if a key is not present it will not be updated

    Returns: updated device
    NOTE: the value null is normally the same as leaving out the key
    except for duration since it can have the value null

    curl --request PATCH \
        --url http://localhost:3000/device%201/2 \
        --header 'Content-Type: application/json' \
        --data '{
            "name": "renamed device"
        }'
    

GET: list all meters with their attached devices
Returns: array of meters

POST: Create a meter
occupants:integer -> how many people live in the house
day_consumption:integer(f32) -> day consumption to start with
night_consumption:integer(f32) -> night consumption to start with

Returns: created meter

  curl --request POST \
      --url http://localhost:3000/meter \
      --header 'Content-Type: application/json' \
      --data '{
          "occupants": 4,
          "day_consumption": 0,
          "night_consumption": 0,
          "latitude": 50.5039,
          "longitude": 4.4699
      }'

• /:meter_id

  • GET: return a specific meter
    Returns: specific meter

  • PATCH: Update the meter
    Same keys as POST /meter if a key is not present it will not be updated

    Returns: updated meter

    curl --request PATCH \
        --url http://localhost:3000/meter/4 \
        --header 'Content-Type: application/json' \
        --data '{
            "occupants": 1,
            "latitude": 50.5039,
            "longitude": 4.4699
        }'
    

  • /update

    • PATCH: Same as GET /meter/:meter_id but this also update/recalculates the usage
      Returns: meter with updated day/night consumption

  • /device

    • POST: Add a device to the current meter from the device listed in GET /device
      device: number/string -> device identifier this can be the id or the name
      on: bool -> Is the device on or off when added

      Returns: created meterdevice

      curl --request POST \
          --url http://localhost:3000/meter/4/device \
          --header 'Content-Type: application/json' \
          --data '{
              "device": 5,
              "on": true
          }'
      

    • /:meterdevice_id

      • GET: Returns a specific meter devices attached to the current meter Returns: specific meterdevice

      • PATCH: Update a meter device on: bool -> turn the device on/off

        Returns: updated meterdevice

        curl --request PATCH \
            --url http://localhost:3000/meter/4/device/13 \
            --header 'Content-Type: application/json' \
            --data '{
                "on": true
            }'