Skip to content

Commit

Permalink
[freeboxos] First big update of README (openhab#17279)
Browse files Browse the repository at this point in the history 
* [freeboxos] First big update of README

Fixes openhab#17074
Fixes openhab#17077
Fixes openhab#17080

Signed-off-by: Laurent Garnier <[email protected]>
  • Loading branch information
@lolodomo @matchews
lolodomo authored and matchews committed Oct 18, 2024
1 parent 2a3610c commit bd6311f
Show file tree
Hide file tree
Showing 11 changed files with 163 additions and 122 deletions.
217 changes: 129 additions & 88 deletions bundles/org.openhab.binding.freeboxos/README.md
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/config/host-config.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<config-description uri="thing-type:freeboxos:host">
<parameter name="refreshInterval" type="integer" min="1" unit="s">
<label>Refresh Interval</label>
<description>The refresh interval in seconds which is used to poll given device</description>
<description>The refresh interval in seconds which is used to poll the device</description>
<default>30</default>
</parameter>
<parameter name="macAddress" type="text" pattern="([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})" required="true">
Expand Down
4 changes: 2 additions & 2 deletions bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/config/player-config.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<config-description uri="thing-type:freeboxos:player">
<parameter name="id" type="integer">
<label>ID</label>
<description>Id of the player</description>
<description>Id of the player within Freebox Api</description>
<default>1</default>
</parameter>
<parameter name="password" type="text" required="false">
Expand All @@ -29,7 +29,7 @@
</parameter>
<parameter name="refreshInterval" type="integer" min="1" unit="s">
<label>Refresh Interval</label>
<description>The refresh interval in seconds which is used to poll the player</description>
<description>The refresh interval in seconds which is used to poll the Freebox player</description>
<default>30</default>
</parameter>
</config-description>
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/config/repeater-config.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</parameter>
<parameter name="id" type="integer" required="true">
<label>ID</label>
<description>Id of the repeater</description>
<description>Id of the repeater within Freebox Api</description>
<default>1</default>
</parameter>
</config-description>
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/config/server-config.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<config-description uri="thing-type:freeboxos:server">
<parameter name="refreshInterval" type="integer" min="1" unit="s">
<label>Refresh Interval</label>
<description>The refresh interval in seconds which is used to poll given Freebox Server</description>
<description>The refresh interval in seconds which is used to poll the Freebox Server</description>
<default>30</default>
</parameter>
</config-description>
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/config/vm-config.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<config-description uri="thing-type:freeboxos:vm">
<parameter name="refreshInterval" type="integer" min="1" unit="s">
<label>Refresh Interval</label>
<description>The refresh interval in seconds which is used to poll given virtual machine</description>
<description>The refresh interval in seconds which is used to poll the virtual machine</description>
<default>30</default>
</parameter>
<parameter name="id" type="integer" required="true">
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/config/wifi-host-config.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<config-description uri="thing-type:freeboxos:wifi-host">
<parameter name="refreshInterval" type="integer" min="1" unit="s">
<label>Refresh Interval</label>
<description>The refresh interval in seconds which is used to poll given device</description>
<description>The refresh interval in seconds which is used to poll the device</description>
<default>30</default>
</parameter>
<parameter name="macAddress" type="text" pattern="([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})" required="true">
Expand Down
34 changes: 17 additions & 17 deletions bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/i18n/freeboxos.properties
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ addon.config.freeboxos.timeout.description = The timeout for reading from the AP
thing-type.freeboxos.active-player.label = Freebox Player
thing-type.freeboxos.active-player.description = The player is the device connected to your TV with API capabilities
thing-type.freeboxos.alarm.label = Freebox Alarm
thing-type.freeboxos.alarm.description = The Alarm system configured in your Freebox Delta Server
thing-type.freeboxos.alarm.description = The Alarm system configured in your Freebox Server
thing-type.freeboxos.alarm.channel.sound.label = Bips Volume
thing-type.freeboxos.alarm.channel.timeout1.label = Alarm Activation Duration
thing-type.freeboxos.alarm.channel.timeout2.label = Safe Zone Alert Timeout
Expand All @@ -24,7 +24,7 @@ thing-type.freeboxos.alarm.channel.volume.label = Alarm Volume
thing-type.freeboxos.api.label = Freebox OS Api
thing-type.freeboxos.api.description = Bridge between hosts and the API rest service
thing-type.freeboxos.basic-shutter.label = Freebox Home Basic Shutter
thing-type.freeboxos.basic-shutter.description = The Basic Shutter (UP,DOWN,STOP) configured in your Freebox Delta Server
thing-type.freeboxos.basic-shutter.description = A basic shutter (UP,DOWN,STOP) configured in your Freebox Server
thing-type.freeboxos.call.label = Phone Calls
thing-type.freeboxos.call.description = Provides various informations regarding the phone calls
thing-type.freeboxos.dect.label = DECT Phone
Expand All @@ -45,15 +45,15 @@ thing-type.freeboxos.fxs.description = Provides various informations regarding t
thing-type.freeboxos.host.label = Network Device
thing-type.freeboxos.host.description = Provides network device reachability
thing-type.freeboxos.kfb.label = Freebox Keyfob
thing-type.freeboxos.kfb.description = A keyfob configured for your Freebox Security system
thing-type.freeboxos.kfb.description = A keyfob configured in your Freebox Server
thing-type.freeboxos.player.label = Freebox Player
thing-type.freeboxos.player.description = The player is the device connected to your TV
thing-type.freeboxos.repeater.label = Wifi Repeater
thing-type.freeboxos.repeater.description = Provides informations and control over a Wifi Repeater
thing-type.freeboxos.revolution.label = Freebox Revolution
thing-type.freeboxos.revolution.description = Provides various informations regarding the status of the Freebox Revolution Server
thing-type.freeboxos.shutter.label = Freebox Home Shutter
thing-type.freeboxos.shutter.description = The Shutter configured in your Freebox Delta Server
thing-type.freeboxos.shutter.description = An IO Home Control shutter configured in your Freebox Server
thing-type.freeboxos.vm.label = Virtual Machine
thing-type.freeboxos.vm.description = Provides informations and control over virtual machine hosted on the server
thing-type.freeboxos.wifihost.label = Wifi Device
Expand Down Expand Up @@ -84,37 +84,37 @@ thing-type.config.freeboxos.home-node.refreshInterval.description = The refresh
thing-type.config.freeboxos.host.macAddress.label = MAC Address
thing-type.config.freeboxos.host.macAddress.description = The MAC address of the network device
thing-type.config.freeboxos.host.refreshInterval.label = Refresh Interval
thing-type.config.freeboxos.host.refreshInterval.description = The refresh interval in seconds which is used to poll given device
thing-type.config.freeboxos.host.refreshInterval.description = The refresh interval in seconds which is used to poll the device
thing-type.config.freeboxos.phone.id.label = ID
thing-type.config.freeboxos.phone.id.description = Id of the phone line
thing-type.config.freeboxos.phone.refreshInterval.label = Refresh Interval
thing-type.config.freeboxos.phone.refreshInterval.description = The refresh interval in seconds which is used to poll for phone state.
thing-type.config.freeboxos.player.acceptAllMp3.label = Accept All MP3
thing-type.config.freeboxos.player.acceptAllMp3.description = Accept any bitrate for MP3 audio or only bitrates greater than 64 kbps
thing-type.config.freeboxos.player.id.label = ID
thing-type.config.freeboxos.player.id.description = Id of the player
thing-type.config.freeboxos.player.id.description = Id of the player within Freebox Api
thing-type.config.freeboxos.player.password.label = Password
thing-type.config.freeboxos.player.password.description = AirPlay password
thing-type.config.freeboxos.player.refreshInterval.label = Refresh Interval
thing-type.config.freeboxos.player.refreshInterval.description = The refresh interval in seconds which is used to poll the player
thing-type.config.freeboxos.player.refreshInterval.description = The refresh interval in seconds which is used to poll the Freebox player
thing-type.config.freeboxos.player.remoteCode.label = Remote Code
thing-type.config.freeboxos.player.remoteCode.description = Code associated to remote control
thing-type.config.freeboxos.repeater.id.label = ID
thing-type.config.freeboxos.repeater.id.description = Id of the repeater
thing-type.config.freeboxos.repeater.id.description = Id of the repeater within Freebox Api
thing-type.config.freeboxos.repeater.refreshInterval.label = Refresh Interval
thing-type.config.freeboxos.repeater.refreshInterval.description = The refresh interval in seconds which is used to poll the repeater
thing-type.config.freeboxos.server.refreshInterval.label = Refresh Interval
thing-type.config.freeboxos.server.refreshInterval.description = The refresh interval in seconds which is used to poll given Freebox Server
thing-type.config.freeboxos.server.refreshInterval.description = The refresh interval in seconds which is used to poll the Freebox Server
thing-type.config.freeboxos.vm.id.label = ID
thing-type.config.freeboxos.vm.id.description = Id of the Virtual Machine
thing-type.config.freeboxos.vm.refreshInterval.label = Refresh Interval
thing-type.config.freeboxos.vm.refreshInterval.description = The refresh interval in seconds which is used to poll given virtual machine
thing-type.config.freeboxos.vm.refreshInterval.description = The refresh interval in seconds which is used to poll the virtual machine
thing-type.config.freeboxos.wifi-host.mDNS.label = mDNS Name
thing-type.config.freeboxos.wifi-host.mDNS.description = The mDNS name of the network device
thing-type.config.freeboxos.wifi-host.macAddress.label = MAC Address
thing-type.config.freeboxos.wifi-host.macAddress.description = The MAC address of the network device
thing-type.config.freeboxos.wifi-host.refreshInterval.label = Refresh Interval
thing-type.config.freeboxos.wifi-host.refreshInterval.description = The refresh interval in seconds which is used to poll given device
thing-type.config.freeboxos.wifi-host.refreshInterval.description = The refresh interval in seconds which is used to poll the device

# channel group types

Expand All @@ -129,9 +129,9 @@ channel-group-type.freeboxos.accepted.channel.timestamp.label = Incoming Call Ti
channel-group-type.freeboxos.actions.label = Server Settings
channel-group-type.freeboxos.connection-status.label = Connection Status Details
channel-group-type.freeboxos.connection-status.channel.bandwidth-down.label = Bandwidth Down
channel-group-type.freeboxos.connection-status.channel.bandwidth-down.description = Raw value of the download bandwidth currently used
channel-group-type.freeboxos.connection-status.channel.bandwidth-down.description = Raw value of the download bandwidth
channel-group-type.freeboxos.connection-status.channel.bandwidth-up.label = Bandwidth Up
channel-group-type.freeboxos.connection-status.channel.bandwidth-up.description = Raw value of the upload bandwidth currently used
channel-group-type.freeboxos.connection-status.channel.bandwidth-up.description = Raw value of the upload bandwidth
channel-group-type.freeboxos.connection-status.channel.bandwidth-usage-down.label = Bandwidth Usage Down
channel-group-type.freeboxos.connection-status.channel.bandwidth-usage-down.description = Portion of the download bandwidth currently used
channel-group-type.freeboxos.connection-status.channel.bandwidth-usage-up.label = Bandwidth Usage Up
Expand All @@ -141,16 +141,16 @@ channel-group-type.freeboxos.connection-status.channel.bytes-down.description =
channel-group-type.freeboxos.connection-status.channel.bytes-up.label = Uploaded
channel-group-type.freeboxos.connection-status.channel.bytes-up.description = Total data uploaded since last restart
channel-group-type.freeboxos.connection-status.channel.ip-address.label = Public IPv4
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)
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)
channel-group-type.freeboxos.connection-status.channel.ipv6-address.label = Public IPv6
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)
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)
channel-group-type.freeboxos.connection-status.channel.rate-down.label = Download Rate
channel-group-type.freeboxos.connection-status.channel.rate-down.description = Current download rate
channel-group-type.freeboxos.connection-status.channel.rate-up.label = Upload Rate
channel-group-type.freeboxos.connection-status.channel.rate-up.description = Current upload rate
channel-group-type.freeboxos.connectivity.label = Network Connectivity
channel-group-type.freeboxos.connectivity.channel.ip-address.label = IP Address
channel-group-type.freeboxos.connectivity.channel.ip-address.description = IPv4 Address of the host
channel-group-type.freeboxos.connectivity.channel.ip-address.description = IPv4 Address of the network device
channel-group-type.freeboxos.connectivity.channel.last-seen.label = Last Activity
channel-group-type.freeboxos.display.label = Front Display Panel
channel-group-type.freeboxos.fans.label = Fans
Expand Down Expand Up @@ -192,7 +192,7 @@ channel-group-type.freeboxos.repeater-misc.channel.box-event.label = Repeater Ev
channel-group-type.freeboxos.sensors.label = System Sensors
channel-group-type.freeboxos.sysinfo.label = System Informations
channel-group-type.freeboxos.sysinfo.channel.ip-address.label = Internal IP
channel-group-type.freeboxos.sysinfo.channel.ip-address.description = Internal IPv4 Address of the host
channel-group-type.freeboxos.sysinfo.channel.ip-address.description = Internal IPv4 Address of the Freebox Server
channel-group-type.freeboxos.vmstatus.label = VM Status
channel-group-type.freeboxos.wifi.label = Wifi Related Information
channel-group-type.freeboxos.wifi.channel.rate-down.label = Rx Rate
Expand Down
8 changes: 4 additions & 4 deletions bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/thing/home-thing-type.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
</supported-bridge-type-refs>

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

<channels>
<channel id="state" typeId="basic-shutter"/>
Expand All @@ -27,7 +27,7 @@
</supported-bridge-type-refs>

<label>Freebox Alarm</label>
<description>The Alarm system configured in your Freebox Delta Server</description>
<description>The Alarm system configured in your Freebox Server</description>

<channels>
<channel id="pin" typeId="alarm-pin"/>
Expand Down Expand Up @@ -61,7 +61,7 @@


<label>Freebox Keyfob</label>
<description>A keyfob configured for your Freebox Security system</description>
<description>A keyfob configured in your Freebox Server</description>

<channels>
<channel id="enable" typeId="keyfob-enable"/>
Expand All @@ -79,7 +79,7 @@
</supported-bridge-type-refs>

<label>Freebox Home Shutter</label>
<description>The Shutter configured in your Freebox Delta Server</description>
<description>An IO Home Control shutter configured in your Freebox Server</description>

<channels>
<channel id="position-set" typeId="shutter"/>
Expand Down
2 changes: 1 addition & 1 deletion ...les/org.openhab.binding.freeboxos/src/main/resources/OH-INF/thing/host-channel-groups.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</channel>
<channel id="ip-address" typeId="ip-address">
<label>IP Address</label>
<description>IPv4 Address of the host</description>
<description>IPv4 Address of the network device</description>
</channel>
</channels>
</channel-group-type>
Expand Down
10 changes: 5 additions & 5 deletions ...s/org.openhab.binding.freeboxos/src/main/resources/OH-INF/thing/server-channel-groups.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<channel id="uptime" typeId="uptime"/>
<channel id="ip-address" typeId="ip-address">
<label>Internal IP</label>
<description>Internal IPv4 Address of the host</description>
<description>Internal IPv4 Address of the Freebox Server</description>
</channel>
<channel id="box-event" typeId="box-event"/>
</channels>
Expand Down Expand Up @@ -92,19 +92,19 @@
<channel id="line-media" typeId="line-media"/>
<channel id="ip-address" typeId="ip-address">
<label>Public IPv4</label>
<description>Public IPv4 Address of the Freebox (this field is only available when connection state is up)</description>
<description>Public IPv4 Address of the Freebox Server (this field is only available when connection state is up)</description>
</channel>
<channel id="ipv6-address" typeId="ip-address">
<label>Public IPv6</label>
<description>Public IPv6 Address of the Freebox (this field is only available when connection state is up)</description>
<description>Public IPv6 Address of the Freebox Server (this field is only available when connection state is up)</description>
</channel>
<channel id="bandwidth-up" typeId="transfer-rate">
<label>Bandwidth Up</label>
<description>Raw value of the upload bandwidth currently used</description>
<description>Raw value of the upload bandwidth</description>
</channel>
<channel id="bandwidth-down" typeId="transfer-rate">
<label>Bandwidth Down</label>
<description>Raw value of the download bandwidth currently used</description>
<description>Raw value of the download bandwidth</description>
</channel>
<channel id="bandwidth-usage-up" typeId="bandwidth-usage">
<label>Bandwidth Usage Up</label>
Expand Down

0 comments on commit bd6311f

Please sign in to comment.