WEG IoT Platform - Product API 1.5.0

This is the WEG API to communicate with products.

Warning: When publishing or subscribing for messages through a gateway it is needed to declare the deviceId and deviceType in the topic. Example: iot-2/type/:deviceType/id/:deviceId/evt/event/fmt/json

Servers

  • 3a4ypl.messaging.internetofthings.ibmcloud.com:{port}mqttdefault

    Development environment - MQTT version 3.1.1 - ISO/IEC PRF 20922 and OASIS Standard

    port
    required
    string

    Default safe port with TLS is 8883

    Default value:"8883"
      Allowed values:
    • "8883"
    • "1883"
  • http(s)://3a4ypl.messaging.internetofthings.ibmcloud.com:{port}/api/v0002wsserver1

    Development environment - HTTP(s)

    port
    required
    string

    Default HTTPS is 443 or 8883 and 1883 unsafe (http). Publish event by a HTTP POST at /device/types/{typeId}/devices/{deviceId}/events/{eventName} and send command at HTTP POST at/device/types/{typeId}/devices/{deviceId}/commands/{commandId}/request

    Default value:"8883"
      Allowed values:
    • "443"
    • "8883"
    • "1883"
  • yv9vc6.messaging.internetofthings.ibmcloud.com:{port}mqttserver2

    Production environment - MQTT version 3.1.1 - ISO/IEC PRF 20922 and OASIS Standard

    port
    required
    string

    Default safe port with TLS is 8883

    Default value:"8883"
      Allowed values:
    • "8883"
    • "1883"
  • http(s)://yv9vc6.messaging.internetofthings.ibmcloud.com:{port}/api/v0002wsserver3

    Production environment - HTTP(s)

    port
    required
    string

    Default HTTPS is 443 or 8883 and 1883 unsafe (http). Publish event by a HTTP POST at /device/types/{typeId}/devices/{deviceId}/events/{eventName} and send command at HTTP POST at /device/types/{typeId}/devices/{deviceId}/commands/{commandId}/request

    Default value:"8883"
      Allowed values:
    • "443"
    • "8883"
    • "1883"

Operations

  • SUB /iot-2/evt/online-mode/fmt/json

    Accepts the following message:

    online-mode

    IoT Platform wake up device to send message in a higher frequency for a period of time.

    object
    • #general

    Examples

  • PUB /iot-2/evt/datetime-now/fmt/json

    Accepts the following message:

    datetime-now

    Request a date time now

    • #general

    Examples

  • SUB /iot-2/cmd/datetime-now-response/fmt/json

    Accepts the following message:

    datetime-now-response

    Subscripe the date time from IoT platform

    object
    • #general

    Examples

  • SUB /iot-2/cmd/on-off/fmt/json

    Accepts the following message:

    on-off

    Subscribe to on-off command

    object
    • #general

    Examples

  • PUB /iot-2/evt/device-status/fmt/json

    Accepts the following message:

    device-status

    Get the device or gateway status and quality of service

    object
    • #general

    Examples

  • PUB /iot-2/evt/version/fmt/json

    Accepts the following message:

    version

    Update device or gateway version

    object
    • #general

    Examples

  • PUB /iot-2/evt/connection-status/fmt/json

    Accepts the following message:

    connection-status

    Get the connection status and quality information

    object
    • #general

    Examples

  • PUB /iot-2/evt/security-token-renew/fmt/json

    Accepts the following message:

    security-token-renew

    Product request a new security token.

    object
    • #general

    Examples

  • SUB /iot-2/cmd/security-update-device/fmt/json

    Accepts the following message:

    security-update-device

    IoT Platform send new token to the product.

    object
    • #general

    Examples

  • PUB /iot-2/evt/security-token-renew-confirmation/fmt/json

    Accepts the following message:

    security-token-renew-confirmation

    Product confirm the change to the new token.

    object
    • #general

    Examples

  • PUB /iot-2/evt/alarm/fmt/json

    Accepts the following message:

    alarm

    Create or finish an alarm.

    A Message without the 'concludedAt' creates the alarm event. The next message with same deviceId plus the 'concludedAt' field will update the event with its conclusion. If no alarm is found, it will create an already finished event.

    object
    • #general

    Examples

  • PUB /iot-2/evt/alarm-v02/fmt/json

    Accepts the following message:

    alarm-v02

    Create or finish an alarm.

    Alarm to solar

    object
    • #general

    Examples

  • PUB /iot-2/evt/vsd-default-v01/fmt/json

    Accepts the following message:

    vsd-default-v01

    Vsd event monitoring.

    object
    • #vsd

    Examples

  • PUB /iot-2/evt/vsd-operation-v01/fmt/json

    Accepts the following message:

    vsd-operation-v01

    Vsd event monitoring.

    object
    • #vsd

    Examples

  • PUB /iot-2/evt/cfw11-diagnostic-v01/fmt/json

    Accepts the following message:

    cfw11-diagnostic-v01

    cfw11 event monitoring.

    object
    • #WEG Inverter CFW11

    Examples

  • PUB /iot-2/evt/cfw11-modulardrive-v01/fmt/json

    Accepts the following message:

    cfw11-modulardrive-v01

    cfw11 event monitoring.

    object
    • #WEG Inverter CFW11

    Examples

  • PUB /iot-2/evt/cfw11-accessoriestemp-v01/fmt/json

    Accepts the following message:

    cfw11-accessoriestemp-v01

    cfw11 event monitoring.

    object
    • #WEG Inverter CFW11

    Examples

  • PUB /iot-2/evt/motor-fft-measurement/fmt/json

    Accepts the following message:

    motor-fft-measurement

    Motor sensor information based on FFT (amplitude and frequency)

    object
    • #motorSensor

    Examples

  • PUB /iot-2/evt/motor-short-measurement/fmt/json

    Accepts the following message:

    motor-short-measurement

    Motor sensor information about motor temperature, environment temperature and motor rpm

    object
    • #motorSensor

    Examples

  • PUB /iot-2/evt/motor-minute-measurement/fmt/json

    Accepts the following message:

    motor-minute-measurement

    Motor sensor information in a MINUTE

    object
    • #motorSensor

    Examples

  • PUB /iot-2/evt/motor-generic-measurement/fmt/json

    Accepts the following message:

    motor-generic-measurement

    Motor sensor information generic motors

    object
    • #motorSensor

    Examples

  • PUB /iot-2/evt/motor-hour-measurement/fmt/json

    Accepts the following message:

    motor-hour-measurement

    Motor sensor information in a HOUR

    object
    • #motorSensor

    Examples

  • PUB /iot-2/evt/motor-gateway-nearby-sensors/fmt/json

    Accepts the following message:

    motor-gateway-nearby-sensors

    Devices nearly motor scan gateway

    object
    • #motorSensor

    Examples

  • PUB /iot-2/evt/solar-generated-energy-v01/fmt/json

    Accepts the following message:

    solar-generated-energy-v01-v03

    Add a register of generated energy

    object
    • #solar

    Examples

  • PUB /iot-2/evt/solar-generated-energy-online-v01/fmt/json

    Accepts the following message:

    solar-generated-energy-v01-v03

    Add a register of generated energy

    object
    • #solar

    Examples

  • PUB /iot-2/evt/solar-generated-energy-v03/fmt/json

    Accepts the following message:

    solar-generated-energy-v01-v03

    Add a register of generated energy

    object
    • #solar

    Examples

  • PUB /iot-2/evt/solar-generated-energy-online-v03/fmt/json

    Accepts the following message:

    solar-generated-energy-v01-v03

    Add a register of generated energy

    object
    • #solar

    Examples

  • PUB /iot-2/evt/solar-generated-energy-v04/fmt/json

    Accepts the following message:

    solar-generated-energy-v01-v04

    Add a register of generated energy [SIW500H-ST060]

    object
    • #solar

    Examples

  • PUB /iot-2/evt/solar-generated-energy-online-v04/fmt/json

    Accepts the following message:

    solar-generated-energy-v01-v04

    Add a register of generated energy [SIW500H-ST060]

    object
    • #solar

    Examples

  • PUB /iot-2/evt/solar-generated-energy-v02/fmt/json

    Accepts the following message:

    solar-generated-energy-v02

    Add a bulk of generated energy

    object
    • #solar

    Examples

  • PUB /iot-2/evt/solar-generated-energy-online-v02/fmt/json

    Accepts the following message:

    solar-generated-energy-v02

    Add a bulk of generated energy

    object
    • #solar

    Examples

  • PUB /iot-2/evt/solar-weather-v01/fmt/json

    Accepts the following message:

    solar-weather-v01

    Weather Station

    object
    • #solar

    Examples

  • PUB /iot-2/evt/solar-weather-v02/fmt/json

    Accepts the following message:

    solar-weather-v02

    Weather Station

    object
    • #solar

    Examples

  • PUB /iot-2/evt/hydro-generator-online-v01/fmt/json

    Accepts the following message:

    hydro-generator-online-v01

    Add a register of online measured varables

    object
    • #hydropower

    Examples

  • PUB /iot-2/evt/hydro-generator-avg-v01/fmt/json

    Accepts the following message:

    hydro-generator-avg-v01

    Add a register of average measured variables

    object
    • #hydropower

    Examples

  • PUB /iot-2/evt/hydro-generator-max-v01/fmt/json

    Accepts the following message:

    hydro-generator-min-max-dev-v01

    This message is used for measured variables in the events of minimum(min), maximum(max) or stantard deviation(dev) values

    object
    • #hydropower

    Examples

  • PUB /iot-2/evt/hydro-generator-min-v01/fmt/json

    Accepts the following message:

    hydro-generator-min-max-dev-v01

    This message is used for measured variables in the events of minimum(min), maximum(max) or stantard deviation(dev) values

    object
    • #hydropower

    Examples

  • PUB /iot-2/evt/hydro-generator-dev-v01/fmt/json

    Accepts the following message:

    hydro-generator-min-max-dev-v01

    This message is used for measured variables in the events of minimum(min), maximum(max) or stantard deviation(dev) values

    object
    • #hydropower

    Examples

  • PUB /iot-2/evt/hydro-turbine-avg-v01/fmt/json

    Accepts the following message:

    hydro-turbine-avg-v01

    Hydraulic turbine monitoring events - average values

    object
    • #hydropower

    Examples

  • PUB /iot-2/evt/hydro-turbine-min-v01/fmt/json

    Accepts the following message:

    hydro-turbine-min-max-v01

    Hydraulic turbine monitoring events - maximum or minimum values

    object
    • #hydropower

    Examples

  • PUB /iot-2/evt/hydro-turbine-max-v01/fmt/json

    Accepts the following message:

    hydro-turbine-min-max-v01

    Hydraulic turbine monitoring events - maximum or minimum values

    object
    • #hydropower

    Examples

  • PUB /iot-2/evt/hydro-turbine-dev-v01/fmt/json

    Accepts the following message:

    hydro-turbine-dev-v01

    Hydraulic turbine monitoring events - stantard deviation values

    object
    • #hydropower

    Examples

  • PUB /iot-2/evt/hydro-turbine-online-v01/fmt/json

    Accepts the following message:

    hydro-turbine-online-v01

    Add a register of online measured varables

    object
    • #hydropower

    Examples

  • PUB /iot-2/evt/transformer-online-v01/fmt/json

    Accepts the following message:

    transformer-online-v01

    Tranformer monitoring events

    object
    • #transformer

    Examples

  • PUB /iot-2/evt/transformer-avg-v01/fmt/json

    Accepts the following message:

    transformer-avg-v01

    Tranformer monitoring events

    object
    • #transformer

    Examples

  • PUB /iot-2/evt/transformer-min-v01/fmt/json

    Accepts the following message:

    transformer-min-max-dev-v01

    Tranformer monitoring events

    object
    • #transformer

    Examples

  • PUB /iot-2/evt/transformer-dry-diag-v01/fmt/json

    Accepts the following message:

    transformer-diag-v01

    transformer monitoring

    object
    • #hedel

    Examples

  • PUB /iot-2/evt/transformer-dry-diag-v02/fmt/json

    Accepts the following message:

    transformer-diag-v02

    transformer monitoring

    object
    • #trasnformer

    Examples

  • PUB /iot-2/evt/transformer-dry-diag-v03/fmt/json

    Accepts the following message:

    transformer-diag-v03

    transformer monitoring

    object
    • #trasnformer

    Examples

  • PUB /iot-2/evt/transformer-dry-diag-v01-online/fmt/json

    Accepts the following message:

    transformer-diag-online-v01

    transformer monitoring

    object
    • #hedel

    Examples

  • PUB /iot-2/evt/transformer-dry-diag-v02-online/fmt/json

    Accepts the following message:

    transformer-dry-diag-online-v02

    transformer monitoring

    object
    • #trasnformer

    Examples

  • PUB /iot-2/evt/transformer-dry-diag-v03-online/fmt/json

    Accepts the following message:

    transformer-diag-online-v03

    transformer monitoring

    object
    • #trasnformer

    Examples

  • PUB /iot-2/evt/transformer-oil-diag-v01/fmt/json

    Accepts the following message:

    transformer-oil-diag-v01

    transformer monitoring

    object
    • #trasnformer

    Examples

  • PUB /iot-2/evt/transformer-oil-diag-v02/fmt/json

    Accepts the following message:

    transformer-oil-diag-v02

    transformer monitoring

    object
    • #trasnformer

    Examples

  • PUB /iot-2/evt/transformer-oil-diag-v01-online/fmt/json

    Accepts the following message:

    transformer-oil-diag-v01-online

    transformer monitoring

    object
    • #trasnformer

    Examples

  • PUB /iot-2/evt/transformer-oil-diag-v02-online/fmt/json

    Accepts the following message:

    transformer-oil-diag-v02-online

    transformer monitoring

    object
    • #trasnformer

    Examples

  • PUB /iot-2/evt/transformer-max-v01/fmt/json

    Accepts the following message:

    transformer-min-max-dev-v01

    Tranformer monitoring events

    object
    • #transformer

    Examples

  • PUB /iot-2/evt/transformer-dev-v01/fmt/json

    Accepts the following message:

    transformer-min-max-dev-v01

    Tranformer monitoring events

    object
    • #transformer

    Examples

  • PUB /iot-2/evt/metered-energy-v01/fmt/json

    Accepts the following message:

    metered-energy-v01

    Add a register of consumed energy

    object
    • #smart-meter

    Examples

  • PUB /iot-2/evt/metered-energy-v01-online/fmt/json

    Accepts the following message:

    metered-energy-v01

    Add a register of consumed energy

    object
    • #smart-meter

    Examples

  • PUB /iot-2/evt/hedel-multifios-status-v01/fmt/json

    Accepts the following message:

    hedel-multifios-status-v01

    Hedel monitoring events

    object
    • #hedel

    Examples

  • PUB /iot-2/evt/cut-started-v01/fmt/json

    Accepts the following message:

    cut-started-v01

    Hedel monitoring events

    object
    • #hedel

    Examples

  • PUB /iot-2/evt/cut-finished-v01/fmt/json

    Accepts the following message:

    cut-finished-v01

    Hedel monitoring events

    object
    • #hedel

    Examples

  • PUB /iot-2/evt/cut-stopped-v01/fmt/json

    Accepts the following message:

    cut-stopped-v01

    Hedel monitoring events

    object
    • #hedel

    Examples

  • PUB /iot-2/evt/cut-restarted-v01/fmt/json

    Accepts the following message:

    cut-restarted-v01

    Hedel monitoring events

    object
    • #hedel

    Examples

  • PUB /iot-2/evt/cut-mode-v01/fmt/json

    Accepts the following message:

    cut-mode-v01

    Hedel monitoring events

    object
    • #hedel

    Examples

  • PUB /iot-2/evt/wire-change-v01/fmt/json

    Accepts the following message:

    wire-change-v01

    Hedel monitoring events

    object
    • #hedel

    Examples

  • PUB /iot-2/evt/solar-multifunction-meter/fmt/json

    Accepts the following message:

    solar-multifunction-meter

    IoT Platform wake up device to send message in a higher frequency for a period of time.

    object
    • #general

    Examples

  • PUB /iot-2/evt/solar-generated-energy-fox/fmt/json

    Accepts the following message:

    solar-generated-energy-fox

    Add a bulk of generated energy Foxess

    object
    • #solar

    Examples

  • PUB /iot-2/evt/solar-generated-energy-v05/fmt/json

    Accepts the following message:

    solar-generated-energy-v05

    Add a bulk of generated energy Foxess

    object
    • #solar

    Examples

  • PUB /iot-2/evt/stall/fmt/json

    Accepts the following message:

    stall

    Weather Station

    object
    • #solar

    Examples

Messages

  • #1online-mode

    IoT Platform wake up device to send message in a higher frequency for a period of time.

    object
    • #general
  • #2datetime-now

    Request a date time now

    • #general
  • #3datetime-now-response

    Subscripe the date time from IoT platform

    object
    • #general
  • #4on-off

    Subscribe to on-off command

    object
    • #general
  • #5device-status

    Get the device or gateway status and quality of service

    object
    • #general
  • #6version

    Update device or gateway version

    object
    • #general
  • #7connection-status

    Get the connection status and quality information

    object
    • #general
  • #8security-token-renew

    Product request a new security token.

    object
    • #general
  • #9security-update-device

    IoT Platform send new token to the product.

    object
    • #general
  • #10security-token-renew-confirmation

    Product confirm the change to the new token.

    object
    • #general
  • #11alarm

    Create or finish an alarm.

    A Message without the 'concludedAt' creates the alarm event. The next message with same deviceId plus the 'concludedAt' field will update the event with its conclusion. If no alarm is found, it will create an already finished event.

    object
    • #general
  • #12alarm-v02

    Create or finish an alarm.

    Alarm to solar

    object
    • #general
  • #13vsd-default-v01

    Vsd event monitoring.

    object
    • #vsd
  • #14vsd-operation-v01

    Vsd event monitoring.

    object
    • #vsd
  • #15cfw11-diagnostic-v01

    cfw11 event monitoring.

    object
    • #WEG Inverter CFW11
  • #16cfw11-modulardrive-v01

    cfw11 event monitoring.

    object
    • #WEG Inverter CFW11
  • #17cfw11-accessoriestemp-v01

    cfw11 event monitoring.

    object
    • #WEG Inverter CFW11
  • #18motor-fft-measurement

    Motor sensor information based on FFT (amplitude and frequency)

    object
    • #motorSensor
  • #19motor-short-measurement

    Motor sensor information about motor temperature, environment temperature and motor rpm

    object
    • #motorSensor
  • #20motor-minute-measurement

    Motor sensor information in a MINUTE

    object
    • #motorSensor
  • #21motor-generic-measurement

    Motor sensor information generic motors

    object
    • #motorSensor
  • #22motor-hour-measurement

    Motor sensor information in a HOUR

    object
    • #motorSensor
  • #23motor-gateway-nearby-sensors

    Devices nearly motor scan gateway

    object
    • #motorSensor
  • #24solar-generated-energy-v01-v03

    Add a register of generated energy

    object
    • #solar
  • #25solar-generated-energy-v01-v04

    Add a register of generated energy [SIW500H-ST060]

    object
    • #solar
  • #26solar-generated-energy-v02

    Add a bulk of generated energy

    object
    • #solar
  • #27solar-weather-v01

    Weather Station

    object
    • #solar
  • #28solar-weather-v02

    Weather Station

    object
    • #solar
  • #29hydro-generator-online-v01

    Add a register of online measured varables

    object
    • #hydropower
  • #30hydro-generator-avg-v01

    Add a register of average measured variables

    object
    • #hydropower
  • #31hydro-generator-min-max-dev-v01

    This message is used for measured variables in the events of minimum(min), maximum(max) or stantard deviation(dev) values

    object
    • #hydropower
  • #32hydro-turbine-avg-v01

    Hydraulic turbine monitoring events - average values

    object
    • #hydropower
  • #33hydro-turbine-min-max-v01

    Hydraulic turbine monitoring events - maximum or minimum values

    object
    • #hydropower
  • #34hydro-turbine-dev-v01

    Hydraulic turbine monitoring events - stantard deviation values

    object
    • #hydropower
  • #35hydro-turbine-online-v01

    Add a register of online measured varables

    object
    • #hydropower
  • #36transformer-online-v01

    Tranformer monitoring events

    object
    • #transformer
  • #37transformer-avg-v01

    Tranformer monitoring events

    object
    • #transformer
  • #38transformer-min-max-dev-v01

    Tranformer monitoring events

    object
    • #transformer
  • #39transformer-diag-v01

    transformer monitoring

    object
    • #hedel
  • #40transformer-diag-v02

    transformer monitoring

    object
    • #trasnformer
  • #41transformer-diag-v03

    transformer monitoring

    object
    • #trasnformer
  • #42transformer-diag-online-v01

    transformer monitoring

    object
    • #hedel
  • #43transformer-dry-diag-online-v02

    transformer monitoring

    object
    • #trasnformer
  • #44transformer-diag-online-v03

    transformer monitoring

    object
    • #trasnformer
  • #45transformer-oil-diag-v01

    transformer monitoring

    object
    • #trasnformer
  • #46transformer-oil-diag-v02

    transformer monitoring

    object
    • #trasnformer
  • #47transformer-oil-diag-v01-online

    transformer monitoring

    object
    • #trasnformer
  • #48transformer-oil-diag-v02-online

    transformer monitoring

    object
    • #trasnformer
  • #49metered-energy-v01

    Add a register of consumed energy

    object
    • #smart-meter
  • #50hedel-multifios-status-v01

    Hedel monitoring events

    object
    • #hedel
  • #51cut-started-v01

    Hedel monitoring events

    object
    • #hedel
  • #52cut-finished-v01

    Hedel monitoring events

    object
    • #hedel
  • #53cut-stopped-v01

    Hedel monitoring events

    object
    • #hedel
  • #54cut-restarted-v01

    Hedel monitoring events

    object
    • #hedel
  • #55cut-mode-v01

    Hedel monitoring events

    object
    • #hedel
  • #56wire-change-v01

    Hedel monitoring events

    object
    • #hedel
  • #57solar-multifunction-meter

    IoT Platform wake up device to send message in a higher frequency for a period of time.

    object
    • #general
  • #58solar-generated-energy-fox

    Add a bulk of generated energy Foxess

    object
    • #solar
  • #59solar-generated-energy-v05

    Add a bulk of generated energy Foxess

    object
    • #solar
  • #60stall

    Weather Station

    object
    • #solar
  • #61solar-goodwe-generated-energy

    Add a bulk of generated energy

    object
    • #solar
  • #62energy-storage-system-v01

    Energy Storage System information about battery, converter, line, optionally generator

    object
    • #energyStorageSystem
  • #63weather

    Weather measurements (temperature and humidity)

    object
    • #weather