Skip to content

Commit b50f81b

Browse files
committed
update the readme
1 parent 9c4332e commit b50f81b

File tree

1 file changed

+34
-12
lines changed
  • addons/binding/org.openhab.binding.intesisbox

1 file changed

+34
-12
lines changed
Lines changed: 34 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
# IntesisBox Binding
22

33
This binding connects to WiFi [IntesisBox](http://www.intesisbox.com/) devices, speaking an ASCII protocol.
4-
It does _not_ support [IntesisHome](http://www.intesishome.com/) devices.
4+
It does _not_ support [IntesisHome](http://www.intesishome.com/) devices. This binding has only been tested against a FJ-RC-WMP-1 IntesisBox.
55

66
## Supported Things
77

8-
This binding has only been tested against a FJ-RC-WMP-1 IntesisBox.
8+
This binding only supports one thing type:
9+
10+
| Thing | Thing Type | Description |
11+
|------------|------------|------------------------------------------------------------------------|
12+
| intesisbox | Thing | Represents a single thermostat |
913

1014
## Discovery
1115

@@ -14,20 +18,38 @@ You can also configure a static IP on the individual thing, or manually add a th
1418

1519
## Thing Configuration
1620

17-
_Describe what is needed to manually configure a thing, either through the (Paper) UI or via a thing-file. This should be mainly about its mandatory and optional configuration parameters. A short example entry for a thing file can help!_
18-
19-
_Note that it is planned to generate some part of this based on the XML files within ```ESH-INF/thing``` of your binding._
21+
You can manually configure an intesisbox thing. If you provide only a MAC Address, it will go through the discovery
22+
process to determine its current IP before connecting. Alternately, you can provide an IP Address for direct connection
23+
without discovery.
2024

2125
## Channels
2226

23-
_Here you should provide information about available channel types, what their meaning is and how they can be used._
24-
25-
_Note that it is planned to generate some part of this based on the XML files within ```ESH-INF/thing``` of your binding._
27+
| Channel ID | Item Type | Description | Possible Values |
28+
|------------|--------------------|-----------------------------------------------------------------------|-|
29+
| onoff | Switch | Turns power on/off for your climate system. | ON, OFF |
30+
| mode | String | The heating/cooling mode. | AUTO, HEAT, COOL, DRY, FAN |
31+
| setptemp | Number:Temperature | The currently set target temperature. | |
32+
| ambtemp | Number:Temperature | (Readonly) The ambient air temperature. | |
33+
| fansp | String | Fan speed (if applicable) | AUTO, 1-9 |
34+
| vaneud | String | Control of up/down vanes (if applicable) | AUTO, 1-9, SWING, PULSE |
35+
| vanelr | String | Control of left/right vanes (if applicable) | AUTO, 1-9, SWING, PULSE |
36+
| errstatus | String | (Readonly) A description of an error coming from your climate system. | |
37+
| errcode | Number | (Readonly) An error code coming from your climate system. | |
38+
39+
Note that individual A/C units may not support all channels, or all possible values for those channels.
40+
For example, not all A/C units have controllable vanes. Or fan speed may be limited to 1-4, instead of all of 1-9.
41+
The set point temperature is also limited to a device specific range. For set point temperature, sending an invalid value
42+
will cause it to choose the minimum/maximum allowable value as appropriate. The device will also round it to
43+
whatever step size it supports. For all other channels, invalid values
44+
are ignored.
2645

2746
## Full Example
2847

29-
_Provide a full usage example based on textual configuration files (*.things, *.items, *.sitemap)._
30-
31-
## Any custom content here!
48+
```intesis.items
49+
Group gLoftThermostat "Loft Minisplit" [ "Thermostat" ]
3250
33-
_Feel free to add additional sections for whatever you think should also be mentioned about your binding!_
51+
Switch LoftMinisplit_Switch "Power" { channel="intesisbox:intesisbox:001dc9835e29:onoff" }
52+
String LoftMinisplit_Mode "Mode" { channel="intesisbox:intesisbox:001dc9835e29:mode" }
53+
Number:Temperature LoftMinisplit_SetPoint "Set Point" (gLoftThermostat) [ "TargetTemperature" ] { channel="intesisbox:intesisbox:001dc9835e29:setptemp" }
54+
Number:Temperature LoftMinisplit_AmbTemp "Ambient Temperature" (gLoftThermostat) [ "CurrentTemperature" ] { channel="intesisbox:intesisbox:001dc9835e29:ambtemp" }
55+
```

0 commit comments

Comments
 (0)