openapi: 3.0.0
servers:
  # Added by API Auto Mocking Plugin
  - description: Local HTTP API
    url: https://{API Url}
    variables:
      API Url:
        default: "192.168.104.118"
        description: Base Url to API

info:
  version: "5.0.0"
  title: Heatit WM Dimmer
  description: The API documentation for WM Dimmer
  contact:
    name: Heatit Support
    url: https://heatit.com/contact
    email: post@heatit.com
  termsOfService: https://heatit.com/terms-of-use-private

externalDocs:
  description: Heatit's documents page
  url: http://documents.heatit.com

tags:
  - name: "Dimmer"
    description: Get data from the device
  - name: "Parameters"
    description: Change parameters on the device
  - name: "BlueFusion"
    description: Get data or change parameters on BlueFusion connected devices.
  - name: "DirectLink"
    description: Set or delete DirectLinks between devices.
  - name: "Reset"
    description: Reset settings, kwh or entire device to factory defaults

paths:
  /api/status:
    get:
      tags:
        - Dimmer
      description: returns all information about the device
      responses:
        "200":
          description: All the devices
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DeviceInfo"

  /api/parameters:
    post:
      tags:
        - Parameters
      description: Change one or more parameters on the device. At least one is required.
      parameters:
        - $ref: "#/components/parameters/powerRestoreLevel"
        - $ref: "#/components/parameters/switchOnLevel"
        - $ref: "#/components/parameters/automaticTurnOff"
        - $ref: "#/components/parameters/automaticTurnOn"
        - $ref: "#/components/parameters/turnOffDelayTime"
        - $ref: "#/components/parameters/switchFunctionality"
        - $ref: "#/components/parameters/allowMultipress"
        - $ref: "#/components/parameters/dimmingDuration"
        - $ref: "#/components/parameters/dimmingCurve"
        - $ref: "#/components/parameters/dimmingMode"
        - $ref: "#/components/parameters/maximumDimLevel"
        - $ref: "#/components/parameters/minimumDimLevel"
        - $ref: "#/components/parameters/onOffFunctionality"
        - $ref: "#/components/parameters/alwaysOn"
        - $ref: "#/components/parameters/disableEnableAutocalibration"
        - $ref: "#/components/parameters/dimLevel"
        - $ref: "#/components/parameters/dimmerState"
        - $ref: "#/components/parameters/doubleClickFor100"
      responses:
        "200":
          description: Successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  powerRestoreLevel:
                    $ref: "#/components/parameters/powerRestoreLevel"
                  switchOnLevel:
                    $ref: "#/components/parameters/switchOnLevel"
                  automaticTurnOff:
                    $ref: "#/components/parameters/automaticTurnOff"
                  automaticTurnOn:
                    $ref: "#/components/parameters/automaticTurnOn"
                  turnOffDelay:
                    $ref: "#/components/parameters/turnOffDelayTime"
                  switchFunctionality:
                    $ref: "#/components/parameters/switchFunctionality"
                  sceneFunctionality:
                    $ref: "#/components/parameters/allowMultipress"
                  dimmingDuration:
                    $ref: "#/components/parameters/dimmingDuration"
                  chooseTheDimmingCurve:
                    $ref: "#/components/parameters/dimmingCurve"
                  loadDimmingMode:
                    $ref: "#/components/parameters/dimmingMode"
                  maximumDimLevel:
                    $ref: "#/components/parameters/maximumDimLevel"
                  minimumDimLevel:
                    $ref: "#/components/parameters/minimumDimLevel"
                  on/onOffFunctionality:
                    $ref: "#/components/parameters/onOffFunctionality"
                  alwayOn:
                    $ref: "#/components/parameters/alwaysOn"
                  enableAutoCalibration:
                    $ref: "#/components/parameters/disableEnableAutocalibration"
                  dimLevel:
                    $ref: "#/components/parameters/dimLevel"
                  dimmerState:
                    $ref: "#/components/parameters/dimmerState"
                  doubleClickFor100:
                    $ref: "#/components/parameters/doubleClickFor100"
              examples:
                Power Restore Level:
                  value:
                    status: Success
                    powerRestoreLevel: 101
                Switch On Level:
                  value:
                    status: Success
                    switchOnLevel: 0
                Automatic Turn Off:
                  value:
                    status: Success
                    automaticTurnOff: 0
                Automatic Turn On:
                  value:
                    status: Success
                    automaticTurnOn: 0
                Turn Off Delay Time:
                  value:
                    status: Success
                    turnOffDelayTime: 0
                Switch Functionality:
                  value:
                    status: Success
                    switchFunctionality: 2
                Allow Multipress:
                  value:
                    status: Success
                    allowMultipress: 2
                Dimming Duration:
                  value:
                    status: Success
                    dimmingDuration: 5.0
                Dimming Curve:
                  value:
                    status: Success
                    dimmingCurve: false
                Dimming Mode:
                  value:
                    status: Success
                    dimmingMode: false
                Maximum Dim Level:
                  value:
                    status: Success
                    maximumDimLevel: 90
                Minimum Dim Level:
                  value:
                    status: Success
                    minimumDimLevel: 15
                On/Off Funtionality:
                  value:
                    status: Success
                    onOffFuntionality: false
                Always On:
                  value:
                    status: Success
                    alwaysOn: false
                Disable/Enable Autocalibration:
                  value:
                    status: Success
                    disableEnableAutocalibration: true
                Dim Level:
                  value:
                    status: Success
                    dimLevel: 50
                Dimmer State:
                  value:
                    status: Success
                    dimmerState: false
                Double click for 100%:
                  value:
                    status: Success
                    doubleClickFor100: 0
                Multiple parameters at the same time:
                  value:
                    status: Success
                    powerRestoreLevel: 100
                    switchOnLevel: 0
                    automaticTurnOff: 0
                    automaticTurnOn: 0
                    turnOffDelayTime: 0
                    switchFunctionality: 2
                    allowMultipress: 2
                    dimmingDuration: 5.0
                    dimmingCurve: false
                    dimmingMode: false
                    maximumDimLevel: 90
                    minimumDimLevel: 15
                    onOffFuntionality: false
                    alwaysOn: false
                    disableEnableAutocalibration: true
                    dimLevel: 50
                    dimmerState: false
                    doubleClickFor100: 0

  /api/reset/factory:
    delete:
      tags:
        - Reset
      summary: Reset the device to factory default.
      description: Reset the device to factory defaults. The device will loose the network connection and must be added to the app again.
      parameters:
        - $ref: "#/components/parameters/reset"
      responses:
        "200":
          description: Successful
          content:
            application/json:
              examples:
                success:
                  value:
                    status: success
                failed:
                  value:
                    status: failed

  /api/reset/settings:
    delete:
      tags:
        - Reset
      summary: Reset settings to factory default.
      description: Resets all settings to factory defaults. This will not reset network settings or remove the device from the app.
      parameters:
        - $ref: "#/components/parameters/reset"
      responses:
        "200":
          description: Successful
          content:
            application/json:
              examples:
                success:
                  value:
                    status: success
                failed:
                  value:
                    status: failed

  /api/reset/kwh:
    delete:
      tags:
        - Reset
      summary: Reset  Kwh to 0.
      description: Reset Kwh to zero.
      parameters:
        - $ref: "#/components/parameters/reset"
      responses:
        "200":
          description: Successful
          content:
            application/json:
              examples:
                success:
                  value:
                    status: success
                failed:
                  value:
                    status: failed

  /api/bluefusion/devices:
    get:
      tags:
        - BlueFusion
      summary: Get list of devices connected via BlueFusion
      description: returns list of devices connected via BlueFusion
      responses:
        "200":
          description: All devices connected via BlueFusion
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Devices"

  /api/bluefusion/{id}/status:
    get:
      tags:
        - BlueFusion
      summary: Get information from the BlueFusion device
      description: Returns all information about the bluetooth device. See the documentation for each device for response schema.
      responses:
        "200":
          description: All the devices
          content:
            application/json:
              examples:
                Wall Controller:
                  value:
                    id: sdf87g4bnfc87a523rbsdf4
                    name: Switch living room
                    room: living room
                    parameters:
                      ledSignalling: false
                      switchFunctionality: 2
                    directLink:
                      brightness: []
                    firmware: 1.2.2

  /api/bluefusion/{id}/parameters:
    post:
      tags:
        - BlueFusion
      summary: Adjust parameters on devices.
      description: Adjust parameters on a BlueFusion connected device. See the documentation for each device for available parameters.
      parameters:
        - $ref: "#/components/parameters/powerRestoreLevel"
        - $ref: "#/components/parameters/switchOnLevel"
        - $ref: "#/components/parameters/automaticTurnOff"
        - $ref: "#/components/parameters/automaticTurnOn"
        - $ref: "#/components/parameters/turnOffDelayTime"
        - $ref: "#/components/parameters/switchFunctionality"
        - $ref: "#/components/parameters/allowMultipress"
        - $ref: "#/components/parameters/dimmingDuration"
        - $ref: "#/components/parameters/dimmingCurve"
        - $ref: "#/components/parameters/dimmingMode"
        - $ref: "#/components/parameters/maximumDimLevel"
        - $ref: "#/components/parameters/minimumDimLevel"
        - $ref: "#/components/parameters/onOffFunctionality"
        - $ref: "#/components/parameters/alwaysOn"
        - $ref: "#/components/parameters/disableEnableAutocalibration"
        - $ref: "#/components/parameters/dimLevel"
        - $ref: "#/components/parameters/dimmerState"
        - $ref: "#/components/parameters/doubleClickFor100"
      responses:
        "200":
          description: Successful
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: "#/components/schemas/powerRestoreLevel"
                  - $ref: "#/components/schemas/switchOnLevel"
                  - $ref: "#/components/schemas/automaticTurnOff"
                  - $ref: "#/components/schemas/automaticTurnOn"
                  - $ref: "#/components/schemas/turnOffDelayTime"
                  - $ref: "#/components/schemas/switchFunctionality"
                  - $ref: "#/components/schemas/allowMultipress"
                  - $ref: "#/components/schemas/dimmingDuration"
                  - $ref: "#/components/schemas/dimmingCurve"
                  - $ref: "#/components/schemas/dimmingMode"
                  - $ref: "#/components/schemas/maximumDimLevel"
                  - $ref: "#/components/schemas/minimumDimLevel"
                  - $ref: "#/components/schemas/onOffFunctionality"
                  - $ref: "#/components/schemas/alwaysOn"
                  - $ref: "#/components/schemas/disableEnableAutocalibration"
                  - $ref: "#/components/schemas/dimLevel"
                  - $ref: "#/components/schemas/dimmerState"
                  - $ref: "#/components/schemas/doubleClickFor100"
              examples:
                Power Restore Level:
                  value:
                    status: success
                    powerRestoreLevel: 101
                Switch On Level:
                  value:
                    status: success
                    switchOnLevel: 0
                Automatic Turn Off:
                  value:
                    status: success
                    automaticTurnOff: 0
                Automatic Turn On:
                  value:
                    status: success
                    automaticTurnOn: 0
                Turn Off Delay Time:
                  value:
                    status: success
                    turnOffDelayTime: 0
                Switch Functionality:
                  value:
                    status: success
                    switchFunctionality: 2
                Allow Multipress:
                  value:
                    status: success
                    allowMultipress: 2
                Dimming Duration:
                  value:
                    status: success
                    dimmingDuration: 5.0
                Dimming Curve:
                  value:
                    status: success
                    dimmingCurve: false
                Dimming Mode:
                  value:
                    status: success
                    dimmingMode: false
                Maximum Dim Level:
                  value:
                    status: success
                    maximumDimLevel: 90
                Minimum Dim Level:
                  value:
                    status: success
                    minimumDimLevel: 15
                On/Off Functionality:
                  value:
                    status: success
                    onOffFunctionality: false
                Always On:
                  value:
                    status: success
                    alwaysOn: false
                Disable/Enable Autocalibration:
                  value:
                    status: success
                    disableEnableAutocalibration: true
                Dim Level:
                  value:
                    status: success
                    dimLevel: 50
                Dimmer State:
                  value:
                    status: success
                    dimmerState: false
                Double click for 100%:
                  value:
                    status: success
                    doubleClickFor100: 0
                Multiple parameters at the same time:
                  value:
                    status: success
                    powerRestoreLevel: 100
                    switchOnLevel: 0
                    automaticTurnOff: 0
                    automaticTurnOn: 0
                    turnOffDelayTime: 0
                    switchFunctionality: 2
                    allowMultipress: 2
                    dimmingDuration: 5.0
                    dimmingCurve: false
                    dimmingMode: false
                    maximumDimLevel: 90
                    minimumDimLevel: 15
                    onOffFunctionality: false
                    alwaysOn: false
                    disableEnableAutocalibration: true
                    dimLevel: 50
                    dimmerState: false
                    doubleClickFor100: 0
        "400":
          description: Failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Status of the request
                  reason:
                    type: string
                    description: Description with reason
              examples:
                Failed:
                  value:
                    status: failed
                    reason: out of range.
                Failed2:
                  value:
                    status: failed
                    reason: invalid data.
        "422":
          description: Validation Error - At least one parameter needs to be changed
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Status of the request
                  reason:
                    type: string
                    description: Description with reason
              example:
                status: failed
                reason: You need to change at least one parameter.

  /api/bluefusion/{id}/reset/factory:
    delete:
      tags:
        - BlueFusion
      summary: Reset the device to factory default.
      description: Reset to factory defaults.
      parameters:
        - name: reset
          description: Turn on or off the feature for open window detection
          in: query
          required: false
          schema:
            type: string
            enum:
              - Reset
      responses:
        "200":
          description: Successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
              examples:
                Success:
                  value:
                    status: success
                Failed:
                  value:
                    status: failed
                    reason: no response from device

  /api/bluefusion/{id}/reset/settings:
    delete:
      tags:
        - BlueFusion
      summary: Reset settings to factory default.
      description: Reset settings to factory defaults.
      parameters:
        - name: resetSettings
          description: Resets all settings to factory defaults. This will not reset network settings or remove the device from the app.
          in: query
          required: false
          schema:
            type: string
            enum:
              - Reset
      responses:
        "200":
          description: Successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
              examples:
                Success:
                  value:
                    status: success
                Failed:
                  value:
                    status: failed
                    reason: no response from device

  /api/bluefusion/{id}/reset/kwh:
    delete:
      tags:
        - BlueFusion
      summary: Reset  Kwh to 0.
      description: Reset Kwh to zero.
      parameters:
        - name: resetKwh
          description: Resets the Kwh counter to 0.
          in: query
          required: false
          schema:
            type: string
            enum:
              - Reset
      responses:
        "200":
          description: Successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
              examples:
                Success:
                  value:
                    status: success
                Failed:
                  value:
                    status: failed
                    reason: no response from device
  /api/directlink:
    get:
      tags:
        - DirectLink
      summary: Get DirectLink status.
      description: Get the status of the DirectLink connection.
      responses:
        "200":
          description: Successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  brightness:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        device:
                          type: string
                  s1:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        device:
                          type: string
                  s2:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        device:
                          type: string
              examples:
                Success:
                  value:
                    brightness:
                      - id: "df4g8b7n2gh9a1c4r4sd2f7"
                        name: "Dimmer living room"
                        device: "WM dimmer"
                    s1:
                      - id: "df4g8b7n2gh9a1c4r4sd2f7"
                        name: "Dimmer living room"
                        device: "WM dimmer"
                    s2:
                      - id: "df4g8b7n2gh9a1c4r4sd2f7"
                        name: "Dimmer living room"
                        device: "WM dimmer"
    post:
      tags:
        - DirectLink
      summary: Start DirectLink pairing mode.
      description: Starts the pairing mode for DirectLink.
      parameters:
        - name: directLink
          description: Choose which function you want to DirectLink
          in: query
          required: true
          schema:
            type: string
            enum:
              - Brightness
              - S1
              - S2
              - Receiving
        - name: nodeId
          description: Node id of the device
          in: query
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
              examples:
                Success:
                  value:
                    status: success.
                    nodeId: "df4g8b7n2gh9a1c4r4sd2f7"
                Failed:
                  value:
                    status: failed
                    reason: no response from device
    delete:
      tags:
        - DirectLink
      summary: Delete a DirectLink connection.
      description: Removes a DirectLink connection.
      parameters:
        - name: directLink
          description: Choose which DirectLink function you want to remove from.
          in: query
          required: true
          schema:
            type: string
            enum:
              - Brightness
              - S1
              - S2
        - name: nodeId
          description: Enter the id of the device you want to remove from the DirectLink connections.
          in: query
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
              examples:
                Success:
                  value:
                    status: success.
                    nodeId: "df4g8b7n2gh9a1c4r4sd2f7"
                Failed:
                  value:
                    status: failed
                    reason: no response from device

components:
  parameters:
    powerRestoreLevel:
      name: powerRestoreLevel
      description: >
        The state the dimmer should return to once power is restored after a power failure.
        <br>**0** = Off
        <br>**1** - **100** = 1% - 100%
        <br>**101** = Returns to level before power outage (Default)
      in: query
      required: false
      schema:
        $ref: "#/components/schemas/powerRestoreLevel"
      example: 50
    switchOnLevel:
      name: switchOnLevel
      description: >
        Defines the dimming level when restored from the OFF state
        <br>**0** = Restores last dim level (Default)
        <br>**1** - **100** = 1% - 100%
      in: query
      required: false
      schema:
        $ref: "#/components/schemas/switchOnLevel"
      example: 50
    automaticTurnOff:
      name: automaticTurnOff
      description: >
        Time to turn OFF device after being turned ON
        <br>**0** = Auto OFF disabled (Default)
        <br>**1** - **86400** = Duration  1-86400 seconds
      in: query
      required: false
      schema:
        $ref: "#/components/schemas/automaticTurnOff"
      example: 3600
    automaticTurnOn:
      name: automaticTurnOn
      description: >
        Time to turn ON device after being turned OFF
        <br>**0** = Auto On disabled (Default)
        <br>**1** - **86400** = Duration  1-86400 seconds
      in: query
      required: false
      schema:
        $ref: "#/components/schemas/automaticTurnOn"
      example: 0
    turnOffDelayTime:
      name: turnOffDelayTime
      description: >
        The time it takes before the dimmer turns off after turning it off.
        <br>**0** = Disabled (Default)
        <br>**1** - **60** = Duration  1-60 seconds
      in: query
      required: false
      schema:
        $ref: "#/components/schemas/turnOffDelayTime"
      example: 10
    switchFunctionality:
      name: switchFunctionality
      description: >
        Decide how the external switches functions
        <br>**0** = Scene controller
        <br>**1** = S1 controls the load (Default)
        <br>**2** = S2 controls the load
        <br>**3** = S1 and S2 controlls the load and scene controller
      in: query
      required: false
      schema:
        $ref: "#/components/schemas/switchFunctionality"
      example: 1
    allowMultipress:
      name: allowMultipress
      description: >
        Decide if multipress will activate scenes or not
        <br>**0** = Multipress will not activate scenes
        <br>**1** = S1 multipress works as scene controller
        <br>**2** = S2 multipress works as scene controller (Default)
        <br>**3** = S1 and S2 multipress work as scene controller
      in: query
      required: false
      schema:
        $ref: "#/components/schemas/allowMultipress"
      example: 2
    dimmingDuration:
      name: dimmingDuration
      description: >
        Define how long it takes to dim when using the external switch.
        <br>**0** = Instantly
        <br>**0.1** - **10.0** = 0.1-10 seconds
        <br>Default: **5.0** = 5 seconds
      in: query
      required: false
      schema:
        $ref: "#/components/schemas/dimmingDuration"
      example: 5.5
    dimmingCurve:
      name: dimmingCurve
      description: >
        Choose if the dimmer uses Linear or Logarithmic dimming.
        <br>**false** = **0** = Linear dimming (Default)
        <br>**true** = **1** = Logarithmic dimming
      in: query
      required: false
      schema:
        $ref: "#/components/schemas/dimmingCurve"
      example: false
    dimmingMode:
      name: dimmingMode
      description: >
        Choose the dimming type. 
        <br>**false** = **0** = Trailing edge (Default)
        <br>**true** = **1** = Leading edge
      in: query
      required: false
      schema:
        $ref: "#/components/schemas/dimmingMode"
      example: false
    maximumDimLevel:
      name: maximumDimLevel
      description: >
        Highest dim level of the dimmer.
        <br>**2** = 2%
        <br>**99** = 99%
        <br>Default: **90** = 90%
      in: query
      required: false
      schema:
        $ref: "#/components/schemas/maximumDimLevel"
      example: 90
    minimumDimLevel:
      name: minimumDimLevel
      description: >
        Lowest dim level of the dimmer.
        <br>**1** = 1%
        <br>**98** = 98%
        <br>Default: **15** = 15%
      in: query
      required: false
      schema:
        $ref: "#/components/schemas/minimumDimLevel"
      example: 15
    onOffFunctionality:
      name: onOffFunctionality
      description: >
        Decide if the load should only turn ON/OFF and not dim
        <br>**false** = **0** = ON/OFF mode disabled (Default)
        <br>**true** = **1** = ON/OFF mode enabled
      in: query
      required: false
      schema:
        $ref: "#/components/schemas/onOffFunctionality"
      example: false
    alwaysOn:
      name: alwaysOn
      description: >
        Decide if the device should be always on or not
        <br>**false** = **0** = Always on disabled (Default)
        <br>**true** = **1** = Always on enabled
      in: query
      required: false
      schema:
        $ref: "#/components/schemas/alwaysOn"
      example: false
    disableEnableAutocalibration:
      name: disableEnableAutocalibration
      description: >
        Choose if the autocalibration should initiate on repower
        <br>**false** = **0** = Disabled, autocalibration will not initiate on repower
        <br>**true** = **1** = Enabled, autocalibration will proceed upon repower (Default)
      in: query
      required: false
      schema:
        $ref: "#/components/schemas/disableEnableAutocalibration"
      example: true
    doubleClickFor100:
      name: doubleClickFor100
      description: >
        Enable or disable double click for 100% function. 
        <br>**0** = Double click disabled (Default)
        <br>**1** = Double click enabled for S1
        <br>**2** = Double click enabled for S2
        <br>**3** = Double click enabled for both
      in: query
      required: false
      schema:
        $ref: "#/components/schemas/doubleClickFor100"
      example: 0
    dimLevel:
      name: dimLevel
      description: >
        Adjust the dim level of the light to your preference. This setting determines the brightness level.
        <br>**1** = 1%
        <br>Default:**50** = 50%
        <br>**100** = 100%
      in: query
      required: false
      schema:
        $ref: "#/components/schemas/dimLevel"
      example: 76
    dimmerState:
      name: dimmerState
      description: >
        Turn the dimmer on and off. When on, it is set to the Dim level. 
        <br>**false** = **0** = Off
        <br>**true** = **1** = On
      in: query
      required: false
      schema:
        $ref: "#/components/schemas/dimmerState"
      example: true
    
    reset:
      name: reset
      description: Requires the string "reset" to prevent accidental resets.
      in: query
      required: true
      schema:
        type: string
        enum:
          - reset
      example: reset

  schemas:
    DeviceInfo:
      type: object
      properties:
        id:
          type: string
          description: Unique id for each device
          example: sdf87g4bnfc87a523rbsdf4
        name:
          type: string
          description: Device name used in the MyHeatit app.
          example: switch hall
        room:
          type: string
          description: The room the device is linked to in the Myheatit app.
          example: hall
        state:
          type: boolean
          description: current state of the dimmer.
            <br>**false** = **0** = dimmer off.
            <br>**true** = **1** = dimmer on.
          example: false
        currentPower:
          type: integer
          pattern: '^\d{1,4}$'
          description: Current power draw of the device in watt.
          example: 2500
        totalConsumption:
          type: number
          format: float
          pattern: '^\d+\.\d{2}$'
          description: Total consumption in kWh
          example: 624.24
        parameters:
          type: object
          properties:
            powerRestoreLevel:
              $ref: "#/components/parameters/powerRestoreLevel"
            switchOnLevel:
              $ref: "#/components/parameters/switchOnLevel"
            automaticTurnOff:
              $ref: "#/components/parameters/automaticTurnOff"
            automaticTurnOn:
              $ref: "#/components/parameters/automaticTurnOn"
            turnOffDelayTime:
              $ref: "#/components/parameters/turnOffDelayTime"
            switchFunctionality:
              $ref: "#/components/parameters/switchFunctionality"
            allowMultipress:
              $ref: "#/components/parameters/allowMultipress"
            dimmingDuration:
              $ref: "#/components/parameters/dimmingDuration"
            dimmingCurve:
              $ref: "#/components/parameters/dimmingCurve"
            dimmingMode:
              $ref: "#/components/parameters/dimmingMode"
            maximumDimLevel:
              $ref: "#/components/parameters/maximumDimLevel"
            minimumDimLevel:
              $ref: "#/components/parameters/minimumDimLevel"
            onOffFunctionality:
              $ref: "#/components/parameters/onOffFunctionality"
            alwaysOn:
              $ref: "#/components/parameters/alwaysOn"
            disableEnableAutocalibration:
              $ref: "#/components/parameters/disableEnableAutocalibration"
            doubleClickFor100:
              $ref: "#/components/parameters/doubleClickFor100"
            dimLevel:
              $ref: "#/components/parameters/dimLevel"
            dimmerState:
              $ref: "#/components/parameters/dimmerState"
        network:
          type: object
          properties:
            SSID:
              type: string
              description: SSID of the connected wifi network
              example: "Home WiFi"
            mac:
              type: string
              description: Mac address of the device
              example: "aa:bb:cc:11:22:33"
            ipAddress:
              type: string
              description: IP address of the device on the local network.
              example: 192.168.1.10
            wifiSignalStrength:
              type: string
              description: Wifi signal strength
              example: "65dBm"
            status:
              type: string
              description: Status of the connection.
              example: ok
        firmware:
          type: string
          description: Current firmware version of the device.
          example: "1.2"
        model:
          type: string
          description: Model of the device.
          example: "Heatit WM Dimmer"

    #Parameters
    powerRestoreLevel:
      type: integer
      pattern: "^d{1,3}$"
      description: >
        The state the dimmer should return to once power is restored after a power failure.
        <br>**0** = Off
        <br>**1** - **100** = 1% - 100%
        <br>**101** = Returns to level before power outage (Default)
      minimum: 0
      maximum: 101
      default: 101
    switchOnLevel:
      type: integer
      pattern: "^d{1,3}$"
      description: >
        Defines the dimming level when restored from the OFF state
        <br>**0** = Restores last dim level (Default)
        <br>**1** - **100** = 1% - 100%
      minimum: 0
      maximum: 100
      default: 0
    automaticTurnOff:
      type: integer
      pattern: "^d{1,5}$"
      description: >
        Time to turn OFF device after being turned ON
        <br>**0** = Auto OFF disabled (Default)
        <br>**1** - **86400** = Duration  1-86400 seconds
      minimum: 0
      maximum: 86400
      default: 0
    automaticTurnOn:
      type: integer
      pattern: "^d{1,5}$"
      description: >
        Time to turn ON device after being turned OFF
        <br>**0** = Auto On disabled (Default)
        <br>**1** - **86400** = Duration  1-86400 seconds
      minimum: 0
      maximum: 86400
      default: 0
    turnOffDelayTime:
      type: integer
      pattern: "^d{1,2}$"
      description: >
        The time it takes before the dimmer turns off after turning it off.
        <br>**0** = Disabled (Default)
        <br>**1** - **60** = Duration  1-60 seconds
      minimum: 0
      maximum: 60
      default: 0
    switchFunctionality:
      type: integer
      pattern: '^\d{1}$'
      description: >
        Decide how the external switches functions
        <br>**0** = Scene controller
        <br>**1** = S1 controls the load (Default)
        <br>**2** = S2 controls the load
        <br>**3** = S1 and S2 controlls the load and scene controller
      enum:
        - 0
        - 1
        - 2
        - 3
      default: 1
    allowMultipress:
      type: integer
      pattern: '^\d{1}$'
      description: >
        Decide if multipress will activate scenes or not
        <br>**0** = Multipress will not activate scenes 
        <br>**1** = S1 multipress works as scene controller
        <br>**2** = S2 multipress works as scene controller (Default)
        <br>**3** = S1 and S2 multipress work as scene controller
      enum:
        - 0
        - 1
        - 2
        - 3
      minimum: 0
      maximum: 3
      default: 2
    dimmingDuration:
      type: number
      pattern: '^\d{1,2}\.\d{1}$'
      description: >
        Define how long it takes to dim when using the external switch.
        <br>**0.0** = Instantly
        <br>**0.1** - **10.0** = 0.1-10 seconds
        <br>Default: **5.0** = 5 seconds
      minimum: 0.0
      maximum: 10.0
      default: 5.0
    dimmingCurve:
      type: boolean
      description: >
        Choose if the dimmer uses Linear or Logarithmic dimming.
        <br>**false** = **0** = Linear dimming (Default)
        <br>**true** = **1** = Logarithmic dimming.
      enum:
        - false
        - true
        - 0
        - 1
      default: false
    dimmingMode:
      type: boolean
      description: >
        Choose the dimming type. 
        <br>**false** = **0** = Trailing edge (Default)
        <br>**true** = **1** = Leading edge
      enum:
        - false
        - true
        - 0
        - 1
      default: false
    maximumDimLevel:
      type: integer
      pattern: '^\d{1,2}'
      description: >
        Highest dim level of the dimmer.
        <br>**2** = 2%
        <br>**99** = 99%
        <br>Default: **90** = 90%
      minimum: 2
      maximum: 99
      default: 90
    minimumDimLevel:
      type: integer
      pattern: '^\d{1,2}'
      description: >
        Lowest dim level of the dimmer.
        <br>**1** = 1%
        <br>**98** = 98%
        <br>Default: **15** = 15%
      minimum: 1
      maximum: 98
      default: 15
    onOffFunctionality:
      type: boolean
      description: >
        Decide if the load should only turn ON/OFF and not dim
        <br>**false** = **0** = ON/OFF mode disabled (Default)
        <br>**true** = **1** = ON/OFF mode enabled
      enum:
        - false
        - true
        - 0
        - 1
      default: false
    alwaysOn:
      type: boolean
      description: >
        Decide if the device should be always on or not
        <br>**false** = **0** = Always on disabled (Default)
        <br>**true** = **1** = Always on enabled
      enum:
        - false
        - true
        - 0
        - 1
      default: false
    disableEnableAutocalibration:
      type: boolean
      description: >
        Choose if the autocalibration should initiate on repower
        <br>**false** = **0** = Disabled, autocalibration will not initiate on repower
        <br>**true** = **1** = Enabled, autocalibration will proceed upon repower (Default)
      enum:
        - false
        - true
        - 0
        - 1
      default: true
    dimLevel:
      type: integer
      pattern: '^\d{1,3}$'
      description: >
        Adjust the dim level of the light to your preference. This setting determines the brightness level.
        <br>**1** = 1%
        <br>Default:**50** = 50%
        <br>**100** = 100%
      default: 50
    dimmerState:
      type: boolean
      description: >
        Turn the dimmer on and off. When on, it is set to the Dim level. 
        <br>**false** = **0** = Off
        <br>**true** = **1** = On
      default: false
    doubleClickFor100:
      type: integer
      pattern: '^\d{1}$'
      description: >
        Enable or disable double click for 100% function. 
        <br>**0** = Double click disabled (Default)
        <br>**1** = Double click enabled for S1
        <br>**2** = Double click enabled for S2
        <br>**3** = Double click enabled for both
      enum:
        - 0
        - 1
        - 2
        - 3
      minimum: 0
      maximum: 3
      default: 0

    Devices:
      type: array
      items:
        type: object
        properties:
          id:
            description: Unique id for each device
            format: id
            example: sdf87g4bnfc87a523rbsdf4
          name:
            type: string
            description: Device name used in the MyHeatit app.
            example: WM dimmer hall
          device:
            type: string
            description: What type of product the device is.
            example: WM dimmer
      example:
        - id: df4g8b7n2gh9a1c4r4sd2f7
          name: Thermostat living room
          device: Heatit WM dimmer hall
        - id: 6f7g8s5a4h9j2k3l1m0n5b2
          name: Thermostat kitchen
          device: Heatit WM dimmer hall
        - id: 9d8c7a6b5f4g1h2i3j4k5l6
          name: Thermostat bedroom
          device: Heatit WM dimmer hall

    ResetInfo:
      type: object
      properties:
        statusSuccess:
          type: string
          enum:
            - success
          example: success