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 Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    AUTHENTICATE
    The endpoint to authenticate a new client to the IKEA TRÃ…DFRI gateway
    Value: "15011/9063"
    static final String
    DEVICES
    The endpoint for IKEA TRÃ…DFRI devices
    Value: "15001"
    static final String
    GATEWAY_DETAILS
    The endpoint to get the details of the IKEA TRÃ…DFRI gateway
    Value: "15011/15012"
    static final String
    GATEWAY_REBOOT
    The endpoint to reboot the IKEA TRÃ…DFRI gateway
    Value: "15011/9030"
    static final String
    GATEWAY_RESET
    The endpoint to reset the IKEA TRÃ…DFRI gateway
    Value: "15011/9031"
    static final String
    GATEWAY_UPDATE_FIRMWARE
    The endpoint to update the firmware of the IKEA TRÃ…DFRI gateway
    Value: "15011/9034"
    static final String
    GROUPS
    The endpoint for IKEA TRÃ…DFRI groups
    Value: "15004"
    static final String
    NOTIFICATIONS
    The endpoint for IKEA TRÃ…DFRI notifications
    Value: "15006"
    static final String
    SCENES
    The endpoint for IKEA TRÃ…DFRI scenes
    Value: "15005"
    static final String
    SMART_TASKS
    The endpoint for IKEA TRÃ…DFRI smart tasks
    Value: "15010"

  • Method Summary

    Modifier and Type
    Method
    Description
    static String
    getBaseUrl()
    Get the base URL of the IKEA TRÃ…DFRI API
    static String
    getGatewayIp()
    Get the IP-address of the IKEA TRÃ…DFRI gateway
    static String
    getUri(String... endpoint)
    Get the URI of an endpoint of the IKEA TRÃ…DFRI API
    static void
    setGatewayIp(String ip)
    Set the IP-address of the IKEA TRÃ…DFRI gateway

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • 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