Free is a French telecom operator providing advanced equipments to manage your broadband access.
This binding integrates the [Freebox Revolution](https://www.free.fr/freebox/freebox-revolution/) and [Freebox Delta](https://www.free.fr/freebox/freebox-delta/) to your openHAB installation.
The server can be connected to Free infrastructures either by xDSL or fiber optic.
This binding provides metrics about your network bridge/router and attached devices (wifi repeaters, TV boxes ...).
It also provides home automation capabilities when appropriate dongle has been inserted in the server.
IliadBox, italian version of the Freebox Pop are also compatible.
| api | Bridge | Bridge to access freebox OS API hosted by the server |
| 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 |
| 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 |
| 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 |
(*) Restricted to servers >= Delta
## Discovery
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
FreeboxOS binding has the following configuration parameters:
| 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 |
## Authentication
You will have to authorize openHAB to connect to your Freebox. Here is the process described:
**Step 1** At binding startup, if no token is recorded in the Freebox Server (bridge) configuration, the binding will run a pairing request
**Step 2** Run to your Freebox and approve the pairing request for openHAB FreeboxOS Binding that is displayed on the Freebox screen
**Step 3** the application token is automatically recorded in the Freebox Server (bridge) configuration
**Step 4** you can use the console command `freeboxos apptoken` to display the application token and use it later to set up your thing in a configuration file
**Step 5** log in your Freebox admin console to allocate needed rights to FreeboxOS Binding
Once initialized, the thing will generate all available channels.
## Channels
The following channels are supported:
| Thing | Channel Type ID | Item Type | Access Mode | Description |
