Manage Logo

Use the functions described below to get, change, and remove the logos from the access terminal.

The devices are capable of storing up to 8 logos and display one exclusively at a time.

Returns the logo image that is stored in the device, the content_type is image/png. When a logo is loaded on the terminal, it is constantly displayed on the main screen if it has been enabled.

POST /logo.fcgi

This request will demand the device to respond with the logo stored in the slot specified. In case no slot is specified, it will answer with the logo on the first slot.

Parameters

  • id: integer (from 1 to 8) (optional)
    • Indicates the index of the slot to get the logo from

Response

  • Logo image previously loaded in the device.

Example

$.ajax({
    url: "/logo.fcgi?session=" + session + "&id=5",
    type: 'POST',
    content-type: 'image/png',
});

Will get the logo on the 6th slot, or a message if there is none.

Changes the logo image of the terminal. The body of the request should contain the PNG of the image and the content-type is application/octet-stream. As a parameter on the request we shall indicate the id as well, if none is passed, the first logo will be changed.

It is important to note that the uploaded image should not exceed 1MB or a resolution of 1000x1000. Any other resolution submitted will be scaled to 272x240 to fit the menu screen.

POST /logo_change.fcgi

Parameters

  • id: integer (from 1 to 8) (optional)
    • Indicates the index of the slot to get the logo from
  • PNG logo image (binary) that must be loaded on the device.

Response

  • The return of the request is an empty JSON object.

Example

$.ajax({
    url: "/logo_change.fcgi?session=" + session + "&id=5",
    type: 'POST',
    content-type: 'application/octet-stream',
    data: image
});

Will change the logo on the 6th slot for the image passed. Or if no index is indicated, the first slot will be modified.

Removes the logo image in the specified slot (or first if none indicated) from the device.

POST /logo_destroy.fcgi

Parameters

  • id: integer (from 1 to 8) (optional)
    • Indicates the index of the slot to get the logo from

Response

  • The return of the request is an empty JSON object.

Example

$.ajax({
    url: "/logo_destroy.fcgi?session=" + session + "&id=5",
    type: 'POST',
});

Will delete the logo on the 6th slot. If no id is passed, it will simply delete the logo on the first slot and configure the device not to show any logo at all (show_logo = 0).

Toggles on logo enabled to be displayed on the screen

POST /set_configuration.fcgi

Parameters

  • show_logo: string (from 0 to 8)
    • Case 0: No logo shall be displayed at all.
    • Case 1-8: The corresponding logo will be displayed

Response

  • The return of the request is an empty JSON object.

Example

$.ajax({
    url: "/set_configuration.fcgi?session=" + session,
    type: 'POST',
    contentType: 'application/json',
    data: JSON.stringify({
        "general": {
            "show_logo": "5"
        }
    })
});

Will set the displayed logo to be the one on the 5th slot and disable the rest.