demus/openhab-addons
1
0
Fork 0
mirror of https://github.com/openhab/openhab-addons.git synced 2025-01-25 14:55:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

[freeboxos] First big update of README (#17279)

Browse Source 
* [freeboxos] First big update of README

Fixes #17074
Fixes #17077
Fixes #17080

Signed-off-by: Laurent Garnier <lg.hc@free.fr>
This commit is contained in:
lolodomo 2024-08-19 19:06:56 +02:00 committed by GitHub
parent b82379cd84
commit 43cc09a2ce
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
11 changed files with 163 additions and 122 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

217
bundles/org.openhab.binding.freeboxos/README.md
View File

@ -21,17 +21,19 @@ This binding supports the following thing types:
| delta | Thing | A Freebox Delta server |
| revolution | Thing | A Freebox Revolution server |
| player | Thing | A TV player equipment |
| active-player | Thing | The TV player equipment with API capabilities (e.g. Devialet) |
| landline | Thing | The phone wired to the Freebox Server |
| active-player | Thing | A TV player equipment with API capabilities (e.g. Devialet) |
| fxs | Thing | The phone wired to the Freebox Server |
| dect | Thing | A DECT phone |
| call | Thing | Phone calls |
| host | Thing | A network device on the local network |
| wifihost | Thing | A wifi networked device on the local network |
| vm (*) | Thing | A virtual machine hosted on the server |
| freeplug | Thing | A virtual machine hosted on the server |
| freeplug | Thing | An Ethernet / CPL gateway |
| repeater | Thing | A Free wifi repeater |
| basic-shutter (*) | Thing | RTS Shutter configured in Freebox Home |
| shutter (*) | Thing | IO Home Control shutter configured in Freebox Home |
| kfb (*) | Thing | A keyfob associated with your alarm system |
| alarm (*) | Thing | The Freebox Home Alarm System |
| vm (*) | Thing | A virtual machine hosted on the server |
| basic-shutter (*) | Thing | A basic shutter configured in your Freebox Server |
| shutter (*) | Thing | An IO Home Control shutter configured in your Freebox Server |
| kfb (*) | Thing | A keyfob configured in your Freebox Server |
| alarm (*) | Thing | The Alarm system configured in your Freebox Server |
(*) Restricted to servers >= Delta
@ -41,18 +43,20 @@ The API bridge is discovered automatically through mDNS in the local network.
After the bridge is discovered and available to openHAB, the binding will automatically discover phone, network devices available on the local network.
Note that the discovered thing will be setup to use only HTTP API (and not HTTPS) because only an IP can be automatically determined while a domain name is required to use HTTPS with a valid certificate.
## Binding configuration
## Binding Configuration
FreeboxOS binding has the following configuration parameters:
| Name | Description | Mandatory |
|-----------------|----------------------------------------------------|-----------|
| timeout | The timeout for reading from the device in seconds | yes |
| Parameter Label | Parameter ID | Description | Default |
|-----------------|--------------|----------------------------------------------------------------------------| |
| Timeout | timeout | The timeout for reading from the API in seconds. | 8 |
| Callback URL | callbackUrl | URL to use for playing notification sounds, e.g. 'http://192.168.0.2:8080' | |
## Thing Configuration
### API bridge
### Api Bridge
The *api* bridge thing requires the following configuration parameters:
| Parameter Label | Parameter ID | Description | Required | Default |
|-------------------------------|---------------------|----------------------------------------------------------------|----------|----------------------|
@ -67,80 +71,99 @@ FreeboxOS binding has the following configuration parameters:
If the parameter *apiDomain* is not set, the binding will use the default address used by Free to access your Freebox Server (mafreebox.freebox.fr).
The bridge thing will initialize only if a valid application token (parameter *appToken*) is filled.
### Server: Revolution or Delta
### Server Things
The *revolution* or *delta* thing requires the following configuration parameters:
| Parameter Label | Parameter ID | Description | Required | Default |
|------------------|-----------------|--------------------------------------------------------------------------|----------|---------|
| Refresh Interval | refreshInterval | The refresh interval (seconds) which is used to poll the Freebox Server. | No | 30 |
| Refresh Interval | refreshInterval | The refresh interval in seconds which is used to poll the Freebox Server | No | 30 |
### Player thing
### Player Things
The *player* thing requires the following configuration parameters:
The *player* or *active-player* thing requires the following configuration parameters:
| Parameter Label | Parameter ID | Description | Required | Default |
|------------------|-----------------|----------------------------------------------------------------------------|----------|---------|
| MAC Address | macAddress | The MAC address of the player device. | Yes | |
| ID | id | Id of the player within Freebox Api | Yes | 1 |
| Player port | port | | No | 24322 |
| Password | password | AirPlay password | No | |
| Remote Code | remoteCode | Code associated to remote control | No | |
| Accept all MP3 | acceptAllMp3 | Accept any bitrate for MP3 audio or only bitrates greater than 64 kbps | No | true |
| Refresh Interval | refreshInterval | The refresh interval in seconds which is used to poll the player | Yes | 30 |
| Callback URL | callbackUrl | URL to use for playing notification sounds, e.g. 'http://192.168.0.2:8080' | No | |
| Refresh Interval | refreshInterval | The refresh interval in seconds which is used to poll the Freebox player | No | 30 |
### Landline
### Phone Things
The *landline* thing requires the following configuration parameters:
The *fxs* or *dect* thing requires the following configuration parameters:
| Parameter Label | Parameter ID | Description | Required | Default |
|------------------|-----------------|------------------------------------------------------------------------|----------|---------|
| Refresh Interval | refreshInterval | The refresh interval in seconds which is used to poll for phone state. | No | 2 |
| ID | id | Id of the phone line | Yes | 1 |
| Refresh Interval | refreshInterval | The refresh interval in seconds which is used to poll for phone state. | No | 30 |
### Network devices: Host
The *call* thing requires the following configuration parameters:
| Parameter Label | Parameter ID | Description | Required | Default |
|------------------|-----------------|------------------------------------------------------------------------|----------|---------|
| Refresh Interval | refreshInterval | The refresh interval in seconds which is used to poll for phone calls. | No | 30 |
### Network Device Things
The *host* thing requires the following configuration parameters:
| Parameter Label | Parameter ID | Description | Required | Default |
|------------------|-----------------|------------------------------------------------------------------------|----------|---------|
| MAC Address | macAddress | The MAC address of the network host. | Yes | |
| Refresh Interval | refreshInterval | The refresh interval in seconds which is used to poll for phone state. | No | 30 |
### Network devices: WifiHost
| MAC Address | macAddress | The MAC address of the network device. | Yes | |
| Refresh Interval | refreshInterval | The refresh interval in seconds which is used to poll the device. | No | 30 |
The *wifihost* thing requires the following configuration parameters:
| Parameter Label | Parameter ID | Description | Required | Default |
|------------------|-----------------|------------------------------------------------------------------------|----------|---------|
| MAC Address | macAddress | The MAC address of the network host. | Yes | |
| Refresh Interval | refreshInterval | The refresh interval in seconds which is used to poll for phone state. | No | 30 |
| mDNS Name | mDNS | The mDNS name of the host. Useful in case of virtual MAC. | No | |
| MAC Address | macAddress | The MAC address of the network device. | Yes | |
| Refresh Interval | refreshInterval | The refresh interval in seconds which is used to poll the device. | No | 30 |
| mDNS Name | mDNS | The mDNS name of the network device. Useful in case of virtual MAC. | No | |
When used, mDNS will search the host based on its mDNS name and eventually update the MAC address accordingly.
This is useful with devices, especially Apple equipment, that uses randomly generated MAC addresses.
### Repeater and Vm thing
### Freeplug Thing
The *repeater* thing is a specialized case of a *wifihost*. The *vm* derives from *host*. They share the same configuration definition:
The *freeplug* thing requires the following configuration parameters:
| Parameter Label | Parameter ID | Description | Required | Default |
|------------------|-----------------|------------------------------------------------------------------|----------|---------|
| MAC Address | macAddress | The MAC address of the player device. | No | |
| ID | id | Id of the repeater within Freebox Api | Yes | 1 |
| Refresh Interval | refreshInterval | The refresh interval in seconds which is used to poll the player | Yes | 30 |
| Parameter Label | Parameter ID | Description | Required | Default |
|------------------|-----------------|------------------------------------------------------------------------|----------|---------|
| MAC Address | macAddress | The MAC address of the network device. | Yes | |
| Refresh Interval | refreshInterval | The refresh interval in seconds which is used to poll the device. | No | 30 |
### Basic shutter thing
### Repeater Thing
The *basic-shutter* thing requires the following configuration parameters:
The *repeater* thing requires the following configuration parameters:
| Parameter Label | Parameter ID | Description | Required | Default |
|------------------|-----------------|---------------------------------------------------------------------|----------|---------|
| ID | id | Id of the repeater within Freebox Api | Yes | 1 |
| Refresh Interval | refreshInterval | The refresh interval in seconds which is used to poll the repeater. | No | 30 |
### Virtual Machine Thing
The *vm* thing requires the following configuration parameters:
| Parameter Label | Parameter ID | Description | Required | Default |
|------------------|-----------------|----------------------------------------------------------------------------|----------|---------|
| ID | id | Id of the Virtual Machine | Yes | 1 |
| Refresh Interval | refreshInterval | The refresh interval in seconds which is used to poll the virtual machine. | No | 30 |
### Home Node Things
The *basic-shutter*, *shutter*, *kfb* or *alarm* thing requires the following configuration parameters:
| Parameter Label | Parameter ID | Description | Required | Default |
|------------------|-----------------|------------------------------------------------------------------|----------|---------|
| ID | id | Id of the Home Node | Yes | 1 |
| UP Slot ID | upSlotId | Id of the UP Slot. | Yes | 0 |
| STOP Slot ID | stopSlotId | Id of the STOP Slot. | Yes | 1 |
| DOWN Slot ID | downSlotId | Id of the DOWN Slot. | Yes | 2 |
| STATE Signal ID | stateSignalId | Id of the STATE Signal. | Yes | 3 |
| Refresh Interval | refreshInterval | The refresh interval in seconds which is used to poll the Node | No | 30 |
## Authentication
@ -162,50 +185,68 @@ Once initialized, the thing will generate all available channels.
The following channels are supported:
| Thing | Channel Type ID | Item Type | Access Mode | Description |
|---------------|-----------------------------|---------------|-------------|--------------------------------------------------------------------------------|
| revolution | lcd-brightness | Number | RW | Brightness level of the screen in percent |
| revolution | lcd-orientation | Number | RW | Screen Orientation in degrees (0 or 90 or 180 or 270) |
| revolution | lcd-forced | Switch | RW | Indicates whether the screen orientation forced |
| server (*) | uptime | Number | R | Time since last reboot of the Freebox Server |
| server (*) | restarted | Switch | R | Indicates whether the Freebox server has restarted during the last poll period |
| server (*) | wifi-status | Switch | RW | Indicates whether the WiFi network is enabled |
| server (*) | ftp-status | Switch | RW | Indicates whether the FTP server is enabled |
| server (*) | airmedia-status | Switch | RW | Indicates whether Air Media is enabled |
| server (*) | upnpav-status | Switch | RW | Indicates whether UPnP AV is enabled |
| server (*) | samba-file-status | Switch | RW | Indicates whether Window File Sharing is enabled |
| server (*) | samba-printer-status | Switch | RW | Indicates whether Window Printer Sharing is enabled |
| server (*) | xdsl-status | String | R | Status of the xDSL line |
| server (*) | ftth-status | Switch | R | Status of the Ftth line |
| server (*) | line-status | String | R | Status of network line connexion |
| server (*) | ipv4 | String | R | Public IP Address of the Freebox Server |
| server (*) | rate-up | Number | R | Current upload rate in byte/s |
| server (*) | rate-down | Number | R | Current download rate in byte/s |
| server (*) | bytes-up | Number | R | Total uploaded bytes since last connection |
| server (*) | bytes-down | Number | R | Total downloaded bytes since last connection |
| phone | state#onhook | Switch | R | Indicates whether the phone is on hook |
| phone | state#ringing | Switch | R | Is the phone ringing |
| call | incoming#number | Call | R | Current incoming call number |
| call | incoming#timestamp | DateTime | R | Current incoming call creation timestamp |
| call | incoming#name | String | R | Current incoming caller name |
| call | accepted#number | Call | R | Last accepted call number |
| call | accepted#duration | Number | R | Last accepted call duration in seconds |
| call | accepted#timestamp | DateTime | R | Last accepted call creation timestamp |
| call | accepted#name | String | R | Last accepted caller name |
| call | missed#number | Call | R | Last missed call number |
| call | missed#timestamp | DateTime | R | Last missed call creation timestamp |
| call | missed#name | String | R | Last missed caller name |
| call | outgoing#number | Call | R | Last outgoing call number |
| call | outgoing#duration | Number | R | Last outgoing call duration in seconds |
| call | outgoing#timestamp | DateTime | R | Last outgoing call creation timestamp |
| call | outgoing#name | String | R | Last outgoing called name |
| net_device | reachable | Switch | R | Indicates whether the network device is reachable |
| net_interface | reachable | Switch | R | Indicates whether the network interface is reachable |
| airplay | playurl | String | W | Play an audio or video media from the given URL |
| airplay | stop | Switch | W | Stop the media playback |
| Thing Type | Channel Grpup ID | Channel ID | Item Type | Access Mode | Description |
|-----------------------|-------------------|----------------------|-------------------------|-------------|--------------------------------------------------------------------------------|
| revolution | display | lcd-brightness | Number:Dimensionless | RW | Brightness level of the screen in percent |
| revolution | display | lcd-orientation | Number | RW | Screen Orientation in degrees (0 or 90 or 180 or 270) |
| revolution | display | lcd-forced | Switch | RW | Indicates whether the screen orientation is forced |
| revolution, delta | file-sharing | ftp-status | Switch | RW | Indicates whether the FTP server is enabled |
| revolution, delta | file-sharing | samba-file-status | Switch | RW | Indicates whether Windows File Sharing is enabled |
| revolution, delta | file-sharing | samba-printer-status | Switch | RW | Indicates whether Windows Printer Sharing is enabled |
| revolution, delta | file-sharing | afp-file-status | Switch | RW | Indicates whether Mac OS File Sharing is enabled |
| revolution, delta | sysinfo | uptime | Number:Time | R | Time since last reboot of the equipment |
| revolution, delta | sysinfo | ip-address | String | R | Internal IPv4 Address of the Freebox Server |
| revolution, delta | sysinfo | box-event | Trigger | - | Triggers when an event related to the Freebox server has been detected. Possible event: "restarted", "firmware_updated" and "reboot_requested" |
| revolution, delta | actions | wifi-status | Switch | RW | Indicates whether the WiFi network is enabled |
| revolution, delta | actions | upnpav-status | Switch | RW | Indicates whether UPnP AV is enabled |
| revolution, delta | actions | airmedia-status | Switch | RW | Indicates whether Air Media is enabled |
| revolution, delta | connection-status | line-status | String | R | Status of network line connection |
| revolution, delta | connection-status | line-type | String | R | Type of network line connection |
| revolution, delta | connection-status | line-media | String | R | Media of network line connection |
| revolution, delta | connection-status | ip-address | String | R | Public IPv4 Address of the Freebox Server |
| revolution, delta | connection-status | ipv6-address | String | R | Public IPv6 Address of the Freebox Server |
| revolution, delta | connection-status | bandwidth-up | Number:DataTransferRate | R | Raw value of the upload bandwidth |
| revolution, delta | connection-status | bandwidth-down | Number:DataTransferRate | R | Raw value of the download bandwidth |
| revolution, delta | connection-status | bandwidth-usage-up | Number:Dimensionless | R | Portion of the upload bandwidth currently used |
| revolution, delta | connection-status | bandwidth-usage-down | Number:Dimensionless | R | Portion of the download bandwidth currently used |
| revolution, delta | connection-status | rate-up | Number:DataTransferRate | R | Current upload rate |
| revolution, delta | connection-status | rate-down | Number:DataTransferRate | R | Current download rate |
| revolution, delta | connection-status | bytes-up | Number:DataAmount | R | Total data uploaded since last restart |
| revolution, delta | connection-status | bytes-down | Number:DataAmount | R | Total data downloaded since last restart |
| active-player, player | player-actions | key-code | String | W | Simulates pushing a remote control button |
| active-player | player-status | player-status | String | R | Status of the Freebox TV player |
| active-player | player-status | package | String | R | Name of the package currently active on the player |
| active-player | sysinfo | uptime | Number:Time | R | Time since last reboot of the equipment |
| active-player | sysinfo | box-event | Trigger | - | Triggers when an event related to the Freebox Player has been detected. Possible event: "restarted", "firmware_updated" and "reboot_requested" |
| vm | vmstatus | status | Switch | RW | Status of the virtual machine |
| (*) | connectivity | reachable | Switch | R | Indicates if the network device is reachable or not |
| (*) | connectivity | last-seen | DateTime | R | Date and time of last activity for the network device |
| (*) | connectivity | ip-address | String | R | IPv4 Address of the network device |
| fxs, dect | | telephony-service | String | R | Status of the telephony service |
| fxs, dect | | ringing | Switch | RW | Is the phone ringing |
| fxs, dect | | hardware-status | String | R | Hardware status of the phone line |
| fxs | | onhook | Switch | R | Indicates whether the phone is on hook |
| dect | | dect-active | Switch | RW | Activates / stops the integrated DECT base |
| dect | | alternate-ring | Switch | RW | Alternating Ring |
| dect | | gain-rx | Dimmer | RW | Gain RX |
| dect | | gain-tx | Dimmer | RW | Gain TX |
| call | incoming | number | Call | R | Current incoming call number |
| call | incoming | timestamp | DateTime | R | Current incoming call creation timestamp |
| call | incoming | name | String | R | Current incoming caller name |
| call | accepted | number | Call | R | Last accepted call number |
| call | accepted | duration | Number:Time | R | Last accepted call duration in seconds |
| call | accepted | timestamp | DateTime | R | Last accepted call creation timestamp |
| call | accepted | name | String | R | Last accepted caller name |
| call | missed | number | Call | R | Last missed call number |
| call | missed | timestamp | DateTime | R | Last missed call creation timestamp |
| call | missed | name | String | R | Last missed caller name |
| call | outgoing | number | Call | R | Last outgoing call number |
| call | outgoing | duration | Number:Time | R | Last outgoing call duration in seconds |
| call | outgoing | timestamp | DateTime | R | Last outgoing call creation timestamp |
| call | outgoing | name | String | R | Last outgoing called name |
| basic-shutter | basic-shutter#basic-shutter | RollerShutter | W | Up, stop and down commands for a RTS shutter |
(*): server means *delta* or *revolution*
(*): any thing type amongst *active-player*, *player*, *host*, *wifihost*, *repeater* and *vm*.
## Actions for rules

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

@ -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">

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

@ -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">
@ -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>

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

@ -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>

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

@ -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>

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

@ -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">

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

@ -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">

34
bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/i18n/freeboxos.properties
View File

@ -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
@ -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
@ -45,7 +45,7 @@ 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
@ -53,7 +53,7 @@ thing-type.freeboxos.repeater.description = Provides informations and control ov
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
@ -84,7 +84,7 @@ 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
@ -92,29 +92,29 @@ thing-type.config.freeboxos.phone.refreshInterval.description = The refresh inte
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
@ -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
@ -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
@ -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

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

@ -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"/>
@ -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"/>
@ -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"/>
@ -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"/>

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

@ -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>

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

@ -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>
@ -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>