LCD

The lcd API allow you to control the Freebox lcd screen settings

LCD Errors

When attempting to access the lcd API, you may encounter the following errors:

error_code Description
inval Invalid parameters
no_panel No screen detected
setup Unable to setup screen

LCD Config

LcdConfig has the following attributes:

LcdConfig
brightness int

the screen brightness (range from 0 to 100)

orientation_forced bool

is the screen orientation forced

orientation int

the screen orientation angle

LCD config API

Get the current LCD configuration

GET /api/v4/lcd/config/

Get the LcdConfig

Example request:

GET /api/v4/lcd/config/ HTTP/1.1
Host: mafreebox.freebox.fr

Example response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "success": true,
    "result": {
        "brightness": 100,
        "orientation": 0,
        "orientation_forced": false
    }
}

Update the lcd configuration

PUT /api/v4/lcd/config/

Update the LcdConfig

Example request:

PUT /api/v4/lcd/config/ HTTP/1.1
Host: mafreebox.freebox.fr
{
  "brightness": 50
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "success": true,
    "result": {
        "brightness": 50,
        "orientation": 0,
        "orientation_forced": false
    }
}