Skip to content

Commit 43cc09a

Browse files
lolodomololodomo
authored
[freeboxos] First big update of README (openhab#17279)
* [freeboxos] First big update of README Fixes openhab#17074 Fixes openhab#17077 Fixes openhab#17080 Signed-off-by: Laurent Garnier <[email protected]>
1 parent b82379c commit 43cc09a

11 files changed

+163
-122
lines changed

‎bundles/org.openhab.binding.freeboxos/README.md

+129-88
Large diffs are not rendered by default.

‎bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/config/host-config.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<config-description uri="thing-type:freeboxos:host">
99
<parameter name="refreshInterval" type="integer" min="1" unit="s">
1010
<label>Refresh Interval</label>
11-
<description>The refresh interval in seconds which is used to poll given device</description>
11+
<description>The refresh interval in seconds which is used to poll the device</description>
1212
<default>30</default>
1313
</parameter>
1414
<parameter name="macAddress" type="text" pattern="([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})" required="true">

‎bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/config/player-config.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<config-description uri="thing-type:freeboxos:player">
88
<parameter name="id" type="integer">
99
<label>ID</label>
10-
<description>Id of the player</description>
10+
<description>Id of the player within Freebox Api</description>
1111
<default>1</default>
1212
</parameter>
1313
<parameter name="password" type="text" required="false">
@@ -29,7 +29,7 @@
2929
</parameter>
3030
<parameter name="refreshInterval" type="integer" min="1" unit="s">
3131
<label>Refresh Interval</label>
32-
<description>The refresh interval in seconds which is used to poll the player</description>
32+
<description>The refresh interval in seconds which is used to poll the Freebox player</description>
3333
<default>30</default>
3434
</parameter>
3535
</config-description>

‎bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/config/repeater-config.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
</parameter>
1414
<parameter name="id" type="integer" required="true">
1515
<label>ID</label>
16-
<description>Id of the repeater</description>
16+
<description>Id of the repeater within Freebox Api</description>
1717
<default>1</default>
1818
</parameter>
1919
</config-description>

‎bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/config/server-config.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<config-description uri="thing-type:freeboxos:server">
99
<parameter name="refreshInterval" type="integer" min="1" unit="s">
1010
<label>Refresh Interval</label>
11-
<description>The refresh interval in seconds which is used to poll given Freebox Server</description>
11+
<description>The refresh interval in seconds which is used to poll the Freebox Server</description>
1212
<default>30</default>
1313
</parameter>
1414
</config-description>

‎bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/config/vm-config.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<config-description uri="thing-type:freeboxos:vm">
99
<parameter name="refreshInterval" type="integer" min="1" unit="s">
1010
<label>Refresh Interval</label>
11-
<description>The refresh interval in seconds which is used to poll given virtual machine</description>
11+
<description>The refresh interval in seconds which is used to poll the virtual machine</description>
1212
<default>30</default>
1313
</parameter>
1414
<parameter name="id" type="integer" required="true">

‎bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/config/wifi-host-config.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<config-description uri="thing-type:freeboxos:wifi-host">
99
<parameter name="refreshInterval" type="integer" min="1" unit="s">
1010
<label>Refresh Interval</label>
11-
<description>The refresh interval in seconds which is used to poll given device</description>
11+
<description>The refresh interval in seconds which is used to poll the device</description>
1212
<default>30</default>
1313
</parameter>
1414
<parameter name="macAddress" type="text" pattern="([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})" required="true">

‎bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/i18n/freeboxos.properties

+17-17
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ addon.config.freeboxos.timeout.description = The timeout for reading from the AP
1515
thing-type.freeboxos.active-player.label = Freebox Player
1616
thing-type.freeboxos.active-player.description = The player is the device connected to your TV with API capabilities
1717
thing-type.freeboxos.alarm.label = Freebox Alarm
18-
thing-type.freeboxos.alarm.description = The Alarm system configured in your Freebox Delta Server
18+
thing-type.freeboxos.alarm.description = The Alarm system configured in your Freebox Server
1919
thing-type.freeboxos.alarm.channel.sound.label = Bips Volume
2020
thing-type.freeboxos.alarm.channel.timeout1.label = Alarm Activation Duration
2121
thing-type.freeboxos.alarm.channel.timeout2.label = Safe Zone Alert Timeout
@@ -24,7 +24,7 @@ thing-type.freeboxos.alarm.channel.volume.label = Alarm Volume
2424
thing-type.freeboxos.api.label = Freebox OS Api
2525
thing-type.freeboxos.api.description = Bridge between hosts and the API rest service
2626
thing-type.freeboxos.basic-shutter.label = Freebox Home Basic Shutter
27-
thing-type.freeboxos.basic-shutter.description = The Basic Shutter (UP,DOWN,STOP) configured in your Freebox Delta Server
27+
thing-type.freeboxos.basic-shutter.description = A basic shutter (UP,DOWN,STOP) configured in your Freebox Server
2828
thing-type.freeboxos.call.label = Phone Calls
2929
thing-type.freeboxos.call.description = Provides various informations regarding the phone calls
3030
thing-type.freeboxos.dect.label = DECT Phone
@@ -45,15 +45,15 @@ thing-type.freeboxos.fxs.description = Provides various informations regarding t
4545
thing-type.freeboxos.host.label = Network Device
4646
thing-type.freeboxos.host.description = Provides network device reachability
4747
thing-type.freeboxos.kfb.label = Freebox Keyfob
48-
thing-type.freeboxos.kfb.description = A keyfob configured for your Freebox Security system
48+
thing-type.freeboxos.kfb.description = A keyfob configured in your Freebox Server
4949
thing-type.freeboxos.player.label = Freebox Player
5050
thing-type.freeboxos.player.description = The player is the device connected to your TV
5151
thing-type.freeboxos.repeater.label = Wifi Repeater
5252
thing-type.freeboxos.repeater.description = Provides informations and control over a Wifi Repeater
5353
thing-type.freeboxos.revolution.label = Freebox Revolution
5454
thing-type.freeboxos.revolution.description = Provides various informations regarding the status of the Freebox Revolution Server
5555
thing-type.freeboxos.shutter.label = Freebox Home Shutter
56-
thing-type.freeboxos.shutter.description = The Shutter configured in your Freebox Delta Server
56+
thing-type.freeboxos.shutter.description = An IO Home Control shutter configured in your Freebox Server
5757
thing-type.freeboxos.vm.label = Virtual Machine
5858
thing-type.freeboxos.vm.description = Provides informations and control over virtual machine hosted on the server
5959
thing-type.freeboxos.wifihost.label = Wifi Device
@@ -84,37 +84,37 @@ thing-type.config.freeboxos.home-node.refreshInterval.description = The refresh
8484
thing-type.config.freeboxos.host.macAddress.label = MAC Address
8585
thing-type.config.freeboxos.host.macAddress.description = The MAC address of the network device
8686
thing-type.config.freeboxos.host.refreshInterval.label = Refresh Interval
87-
thing-type.config.freeboxos.host.refreshInterval.description = The refresh interval in seconds which is used to poll given device
87+
thing-type.config.freeboxos.host.refreshInterval.description = The refresh interval in seconds which is used to poll the device
8888
thing-type.config.freeboxos.phone.id.label = ID
8989
thing-type.config.freeboxos.phone.id.description = Id of the phone line
9090
thing-type.config.freeboxos.phone.refreshInterval.label = Refresh Interval
9191
thing-type.config.freeboxos.phone.refreshInterval.description = The refresh interval in seconds which is used to poll for phone state.
9292
thing-type.config.freeboxos.player.acceptAllMp3.label = Accept All MP3
9393
thing-type.config.freeboxos.player.acceptAllMp3.description = Accept any bitrate for MP3 audio or only bitrates greater than 64 kbps
9494
thing-type.config.freeboxos.player.id.label = ID
95-
thing-type.config.freeboxos.player.id.description = Id of the player
95+
thing-type.config.freeboxos.player.id.description = Id of the player within Freebox Api
9696
thing-type.config.freeboxos.player.password.label = Password
9797
thing-type.config.freeboxos.player.password.description = AirPlay password
9898
thing-type.config.freeboxos.player.refreshInterval.label = Refresh Interval
99-
thing-type.config.freeboxos.player.refreshInterval.description = The refresh interval in seconds which is used to poll the player
99+
thing-type.config.freeboxos.player.refreshInterval.description = The refresh interval in seconds which is used to poll the Freebox player
100100
thing-type.config.freeboxos.player.remoteCode.label = Remote Code
101101
thing-type.config.freeboxos.player.remoteCode.description = Code associated to remote control
102102
thing-type.config.freeboxos.repeater.id.label = ID
103-
thing-type.config.freeboxos.repeater.id.description = Id of the repeater
103+
thing-type.config.freeboxos.repeater.id.description = Id of the repeater within Freebox Api
104104
thing-type.config.freeboxos.repeater.refreshInterval.label = Refresh Interval
105105
thing-type.config.freeboxos.repeater.refreshInterval.description = The refresh interval in seconds which is used to poll the repeater
106106
thing-type.config.freeboxos.server.refreshInterval.label = Refresh Interval
107-
thing-type.config.freeboxos.server.refreshInterval.description = The refresh interval in seconds which is used to poll given Freebox Server
107+
thing-type.config.freeboxos.server.refreshInterval.description = The refresh interval in seconds which is used to poll the Freebox Server
108108
thing-type.config.freeboxos.vm.id.label = ID
109109
thing-type.config.freeboxos.vm.id.description = Id of the Virtual Machine
110110
thing-type.config.freeboxos.vm.refreshInterval.label = Refresh Interval
111-
thing-type.config.freeboxos.vm.refreshInterval.description = The refresh interval in seconds which is used to poll given virtual machine
111+
thing-type.config.freeboxos.vm.refreshInterval.description = The refresh interval in seconds which is used to poll the virtual machine
112112
thing-type.config.freeboxos.wifi-host.mDNS.label = mDNS Name
113113
thing-type.config.freeboxos.wifi-host.mDNS.description = The mDNS name of the network device
114114
thing-type.config.freeboxos.wifi-host.macAddress.label = MAC Address
115115
thing-type.config.freeboxos.wifi-host.macAddress.description = The MAC address of the network device
116116
thing-type.config.freeboxos.wifi-host.refreshInterval.label = Refresh Interval
117-
thing-type.config.freeboxos.wifi-host.refreshInterval.description = The refresh interval in seconds which is used to poll given device
117+
thing-type.config.freeboxos.wifi-host.refreshInterval.description = The refresh interval in seconds which is used to poll the device
118118

119119
# channel group types
120120

@@ -129,9 +129,9 @@ channel-group-type.freeboxos.accepted.channel.timestamp.label = Incoming Call Ti
129129
channel-group-type.freeboxos.actions.label = Server Settings
130130
channel-group-type.freeboxos.connection-status.label = Connection Status Details
131131
channel-group-type.freeboxos.connection-status.channel.bandwidth-down.label = Bandwidth Down
132-
channel-group-type.freeboxos.connection-status.channel.bandwidth-down.description = Raw value of the download bandwidth currently used
132+
channel-group-type.freeboxos.connection-status.channel.bandwidth-down.description = Raw value of the download bandwidth
133133
channel-group-type.freeboxos.connection-status.channel.bandwidth-up.label = Bandwidth Up
134-
channel-group-type.freeboxos.connection-status.channel.bandwidth-up.description = Raw value of the upload bandwidth currently used
134+
channel-group-type.freeboxos.connection-status.channel.bandwidth-up.description = Raw value of the upload bandwidth
135135
channel-group-type.freeboxos.connection-status.channel.bandwidth-usage-down.label = Bandwidth Usage Down
136136
channel-group-type.freeboxos.connection-status.channel.bandwidth-usage-down.description = Portion of the download bandwidth currently used
137137
channel-group-type.freeboxos.connection-status.channel.bandwidth-usage-up.label = Bandwidth Usage Up
@@ -141,16 +141,16 @@ channel-group-type.freeboxos.connection-status.channel.bytes-down.description =
141141
channel-group-type.freeboxos.connection-status.channel.bytes-up.label = Uploaded
142142
channel-group-type.freeboxos.connection-status.channel.bytes-up.description = Total data uploaded since last restart
143143
channel-group-type.freeboxos.connection-status.channel.ip-address.label = Public IPv4
144-
channel-group-type.freeboxos.connection-status.channel.ip-address.description = Public IPv4 Address of the Freebox (this field is only available when connection state is up)
144+
channel-group-type.freeboxos.connection-status.channel.ip-address.description = Public IPv4 Address of the Freebox Server (this field is only available when connection state is up)
145145
channel-group-type.freeboxos.connection-status.channel.ipv6-address.label = Public IPv6
146-
channel-group-type.freeboxos.connection-status.channel.ipv6-address.description = Public IPv6 Address of the Freebox (this field is only available when connection state is up)
146+
channel-group-type.freeboxos.connection-status.channel.ipv6-address.description = Public IPv6 Address of the Freebox Server (this field is only available when connection state is up)
147147
channel-group-type.freeboxos.connection-status.channel.rate-down.label = Download Rate
148148
channel-group-type.freeboxos.connection-status.channel.rate-down.description = Current download rate
149149
channel-group-type.freeboxos.connection-status.channel.rate-up.label = Upload Rate
150150
channel-group-type.freeboxos.connection-status.channel.rate-up.description = Current upload rate
151151
channel-group-type.freeboxos.connectivity.label = Network Connectivity
152152
channel-group-type.freeboxos.connectivity.channel.ip-address.label = IP Address
153-
channel-group-type.freeboxos.connectivity.channel.ip-address.description = IPv4 Address of the host
153+
channel-group-type.freeboxos.connectivity.channel.ip-address.description = IPv4 Address of the network device
154154
channel-group-type.freeboxos.connectivity.channel.last-seen.label = Last Activity
155155
channel-group-type.freeboxos.display.label = Front Display Panel
156156
channel-group-type.freeboxos.fans.label = Fans
@@ -192,7 +192,7 @@ channel-group-type.freeboxos.repeater-misc.channel.box-event.label = Repeater Ev
192192
channel-group-type.freeboxos.sensors.label = System Sensors
193193
channel-group-type.freeboxos.sysinfo.label = System Informations
194194
channel-group-type.freeboxos.sysinfo.channel.ip-address.label = Internal IP
195-
channel-group-type.freeboxos.sysinfo.channel.ip-address.description = Internal IPv4 Address of the host
195+
channel-group-type.freeboxos.sysinfo.channel.ip-address.description = Internal IPv4 Address of the Freebox Server
196196
channel-group-type.freeboxos.vmstatus.label = VM Status
197197
channel-group-type.freeboxos.wifi.label = Wifi Related Information
198198
channel-group-type.freeboxos.wifi.channel.rate-down.label = Rx Rate

‎bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/thing/home-thing-type.xml

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
</supported-bridge-type-refs>
1111

1212
<label>Freebox Home Basic Shutter</label>
13-
<description>The Basic Shutter (UP,DOWN,STOP) configured in your Freebox Delta Server</description>
13+
<description>A basic shutter (UP,DOWN,STOP) configured in your Freebox Server</description>
1414

1515
<channels>
1616
<channel id="state" typeId="basic-shutter"/>
@@ -27,7 +27,7 @@
2727
</supported-bridge-type-refs>
2828

2929
<label>Freebox Alarm</label>
30-
<description>The Alarm system configured in your Freebox Delta Server</description>
30+
<description>The Alarm system configured in your Freebox Server</description>
3131

3232
<channels>
3333
<channel id="pin" typeId="alarm-pin"/>
@@ -61,7 +61,7 @@
6161

6262

6363
<label>Freebox Keyfob</label>
64-
<description>A keyfob configured for your Freebox Security system</description>
64+
<description>A keyfob configured in your Freebox Server</description>
6565

6666
<channels>
6767
<channel id="enable" typeId="keyfob-enable"/>
@@ -79,7 +79,7 @@
7979
</supported-bridge-type-refs>
8080

8181
<label>Freebox Home Shutter</label>
82-
<description>The Shutter configured in your Freebox Delta Server</description>
82+
<description>An IO Home Control shutter configured in your Freebox Server</description>
8383

8484
<channels>
8585
<channel id="position-set" typeId="shutter"/>

‎bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/thing/host-channel-groups.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
</channel>
1414
<channel id="ip-address" typeId="ip-address">
1515
<label>IP Address</label>
16-
<description>IPv4 Address of the host</description>
16+
<description>IPv4 Address of the network device</description>
1717
</channel>
1818
</channels>
1919
</channel-group-type>

‎bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/thing/server-channel-groups.xml

+5-5
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
<channel id="uptime" typeId="uptime"/>
1919
<channel id="ip-address" typeId="ip-address">
2020
<label>Internal IP</label>
21-
<description>Internal IPv4 Address of the host</description>
21+
<description>Internal IPv4 Address of the Freebox Server</description>
2222
</channel>
2323
<channel id="box-event" typeId="box-event"/>
2424
</channels>
@@ -92,19 +92,19 @@
9292
<channel id="line-media" typeId="line-media"/>
9393
<channel id="ip-address" typeId="ip-address">
9494
<label>Public IPv4</label>
95-
<description>Public IPv4 Address of the Freebox (this field is only available when connection state is up)</description>
95+
<description>Public IPv4 Address of the Freebox Server (this field is only available when connection state is up)</description>
9696
</channel>
9797
<channel id="ipv6-address" typeId="ip-address">
9898
<label>Public IPv6</label>
99-
<description>Public IPv6 Address of the Freebox (this field is only available when connection state is up)</description>
99+
<description>Public IPv6 Address of the Freebox Server (this field is only available when connection state is up)</description>
100100
</channel>
101101
<channel id="bandwidth-up" typeId="transfer-rate">
102102
<label>Bandwidth Up</label>
103-
<description>Raw value of the upload bandwidth currently used</description>
103+
<description>Raw value of the upload bandwidth</description>
104104
</channel>
105105
<channel id="bandwidth-down" typeId="transfer-rate">
106106
<label>Bandwidth Down</label>
107-
<description>Raw value of the download bandwidth currently used</description>
107+
<description>Raw value of the download bandwidth</description>
108108
</channel>
109109
<channel id="bandwidth-usage-up" typeId="bandwidth-usage">
110110
<label>Bandwidth Usage Up</label>

0 commit comments

Comments
 (0)