Package org.openremote.agent.protocol.tradfri.util

Class ApiEndpoint

java.lang.Object
org.openremote.agent.protocol.tradfri.util.ApiEndpoint
public class ApiEndpoint extends Object
The class that contains helper functions and constants to find CoAP endpoints for the IKEA TRÅDFRI gateway

  • Field Details

    • AUTHENTICATE

      public static final String AUTHENTICATE
      The endpoint to authenticate a new client to the IKEA TRÅDFRI gateway
      Value: "15011/9063"
      See Also:

    • GATEWAY_REBOOT

      public static final String GATEWAY_REBOOT
      The endpoint to reboot the IKEA TRÅDFRI gateway
      Value: "15011/9030"
      See Also:

    • GATEWAY_RESET

      public static final String GATEWAY_RESET
      The endpoint to reset the IKEA TRÅDFRI gateway
      Value: "15011/9031"
      See Also:

    • GATEWAY_UPDATE_FIRMWARE

      public static final String GATEWAY_UPDATE_FIRMWARE
      The endpoint to update the firmware of the IKEA TRÅDFRI gateway
      Value: "15011/9034"
      See Also:

    • GATEWAY_DETAILS

      public static final String GATEWAY_DETAILS
      The endpoint to get the details of the IKEA TRÅDFRI gateway
      Value: "15011/15012"
      See Also:

    • DEVICES

      public static final String DEVICES
      The endpoint for IKEA TRÅDFRI devices
      Value: "15001"
      See Also:

    • GROUPS

      public static final String GROUPS
      The endpoint for IKEA TRÅDFRI groups
      Value: "15004"
      See Also:

    • SCENES

      public static final String SCENES
      The endpoint for IKEA TRÅDFRI scenes
      Value: "15005"
      See Also:

    • NOTIFICATIONS

      public static final String NOTIFICATIONS
      The endpoint for IKEA TRÅDFRI notifications
      Value: "15006"
      See Also:

    • SMART_TASKS

      public static final String SMART_TASKS
      The endpoint for IKEA TRÅDFRI smart tasks
      Value: "15010"
      See Also:

  • Method Details

    • getGatewayIp

      public static String getGatewayIp()
      Get the IP-address of the IKEA TRÅDFRI gateway
      Returns:
      The IP-address of the IKEA TRÅDFRI gateway

    • setGatewayIp

      public static void setGatewayIp(String ip)
      Set the IP-address of the IKEA TRÅDFRI gateway
      Parameters:
      ip - The IP-address of the IKEA TRÅDFRI gateway

    • getBaseUrl

      public static String getBaseUrl()
      Get the base URL of the IKEA TRÅDFRI API
      Returns:
      The base URL of the IKEA TRÅDFRI API

    • getUri

      public static String getUri(String... endpoint)
      Get the URI of an endpoint of the IKEA TRÅDFRI API
      Parameters:
      endpoint - The endpoint paths
      Returns:
      The URI of the endpoint of the IKEA TRÅDFRI API