EcoWatch Api 1.0.0

EcoWatch Api gives you full control of the display capabilities and settings of your EcoWatch using MQTT!

Features

  • Control display settings automatically
  • Get energy price information directly from the EcoWatch (Current cost, historical average)
  • Use the EcoWatch as a display for your own data by controlling the LEDs yourself!

Operations

  • REQUEST ecowatch/ping

    Send a ping to the EcoWatch and recieve details with the pong.

    Operation IDPing Request

    Accepts the following message:

    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: ecowatch/ping
  • SEND ecowatch/{ecowatchId}/set/settings

    Set some or all the settings for the EcoWatch

    Operation IDSet Settings

    Accepts the following message:

    settings
    Message IDsettings
    object

    Examples

  • SEND ecowatch/{ecowatchId}/set/pixels

    Set specific pixels to specific colors on the EcoWatch

    Operation IDSet Pixels

    Accepts the following message:

    colors
    Message IDcolors
    object

    Examples

  • SEND ecowatch/{ecowatchId}/set/hours

    Set all pixels of some hours to specific colors on the EcoWatch

    Operation IDSet hours

    Accepts the following message:

    colors
    Message IDcolors
    object

    Examples

  • SEND ecowatch/{ecowatchId}/clear

    Clear the colors from the rings of the EcoWatch. If no parameters are given, both rings will be cleared

    Operation IDClear Display

    Accepts the following message:

    clear
    Message IDclear
    object

    Examples

  • SEND ecowatch/{ecowatchId}/reset

    Reset the rings, returning the functionality back to EcoWatch. If no parameters are given, both rings will be reset

    Operation IDReset Display

    Accepts the following message:

    reset
    Message IDreset
    object

    Examples

Messages

  • #1pong
    Message IDpong
    object
  • #2settings
    Message IDsettings
    object
  • #3colors
    Message IDcolors
    object
  • #4clear
    Message IDclear
    object
  • #5reset
    Message IDreset
    object

Schemas

  • object
  • object
  • object
  • object
  • array<object>
  • object
  • object
  • CurrencyChoice
    string

    The currency choice for the EcoWatch

    • 0: EUR
    • 1: SEK
    • 2: NOK
    • 3: DKK

    Any other value defaults to EUR

      Allowed values:
    • "0"
    • "1"
    • "2"
    • "3"
  • ShowChoice
    string

    The display choice for the main ring (outer) of the EcoWatch

    • 0: Average price
    • 1: Extended average price
    • 2: Own price range
    • 3: Green hours
      Allowed values:
    • "0"
    • "1"
    • "2"
    • "3"
  • LowUnderZero
    string

    Parameter to enable low price display always if price is under zero (negative)

      Allowed values:
    • "on"
    • "off"
  • AverageLength
    string

    The amount of days to use for the extended average ShowChoice [1-7]

  • LowPriceValue
    string

    The value to use as the low price zone

  • MediumPriceValue
    string

    The value to use as the medium price zone

    Everything above medium price is considered high price

  • GreenHourAmountBasic
    string

    The amount of green hours to display on the EcoWatch for the green hour ShowChoice [1-24]

  • BlinkHour
    string

    Parameter to enable blink on the outer ring for current hour

      Allowed values:
    • "on"
    • "off"
  • ColorLowPrice
    string
    must match: ^#([A-F0-9]{6})$

    The color to use for the low price zone

  • ColorMediumPrice
    string
    must match: ^#([A-F0-9]{6})$

    The color to use for the medium price zone

  • ColorHighPrice
    string
    must match: ^#([A-F0-9]{6})$

    The color to use for the high price zone

  • Brightness
    integer
    [ 0 .. 100 ]

    The brightness of the LEDs on the EcoWatch

  • LedTimer
    string

    Parameter to enable the LED timer

      Allowed values:
    • "on"
    • "off"
  • LedStartTime
    string
    must match: ^[0-9]{2}:[0-9]{2}$

    The time when the leds should turn off

  • LedStopTime
    string
    must match: ^[0-9]{2}:[0-9]{2}$

    The time when the leds should turn back on

  • ExtraDisplayChoice
    string

    The display choice for the secondary ring (inner) of the EcoWatch

    • 0: Nothing / Off
    • 1: Tariff display
    • 2: Green hours
      Allowed values:
    • "0"
    • "1"
    • "2"
  • GreenHourAmount
    string

    The amount of green hours to display on the EcoWatch for the green hour ExtraDisplayChoice [1-24]

  • TariffStartTime
    string
    must match: ^[0-9]{2}:[0-9]{2}$

    The time when tariff starts

  • TariffStopTime
    string
    must match: ^[0-9]{2}:[0-9]{2}$

    The time when tariff stops

  • TariffDayChoice
    string

    The choice of day for the tariff display

    • 0: Non-holiday weekdays
    • 1: Everyday
      Allowed values:
    • "0"
    • "1"
  • TariffStartMonth
    string

    The month when tariff starts (zero indexed) [0-11]

  • TariffStopMonth
    string

    The month when tariff stops (zero indexed) [0-11]

  • TariffColor
    string
    must match: ^#([A-F0-9]{6})$

    The color to use for the tariff display

  • UnknownColorOff
    string

    If the unknown prices should be turned off instead of displayed as a color

      Allowed values:
    • "on"
    • "off"
  • object

    The color and position of a single pixel on the EcoWatch