Skip to content

Commit

Permalink
Thing status description clickable link to binding's url
Browse files Browse the repository at this point in the history
See openhab/openhab-webui#2996

Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
  • Loading branch information
jimtng committed Jan 10, 2025
1 parent 673da56 commit d9e8c10
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions developers/bindings/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ If the device or service is not working correctly, the binding should change the
The status can be updated via an inherited method from the BaseThingHandler class by calling:

```java
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.OFFLINE.COMMUNICATION_ERROR);
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR);
```

The second argument of the method takes a `ThingStatusDetail` enumeration value, which further specifies the current status situation.
Expand All @@ -332,7 +332,16 @@ The binding should also provide additional status description, if available.
This description might contain technical information (e.g. an HTTP status code, or any other protocol specific information, which helps to identify the current problem):

```java
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.OFFLINE.COMMUNICATION_ERROR, "HTTP 403 - Access denied");
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, "HTTP 403 - Access denied");
```

Some bindings may need to collect further configuration or login credentials through its servlet, hosted by openHAB.
A link can be included in the status description when it starts with: `http(s)://<YOUROPENHAB>:<YOURPORT>/` followed by binding-specific path.
This special string will be converted into a clickable link with the same openhab host and port that Main UI is connected to.
For example:

```java
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, "Please login through: http(s)://<YOUROPENHAB>:<YOURPORT>/mybinding/" + getThing().getUID().getId());
```

After the thing is created, the framework calls the `initialize` method of the handler.
Expand Down

0 comments on commit d9e8c10

Please sign in to comment.