Device 

Device object contains settings and status of a single device.

It has the following attributes:

• Uuid (unique identifier) - read only

• SessionId (WebKit session id - multiple devices can have the same SessionId)

• State (offline or online) - read only

• Displays (array of device displays) Each display contains the following fields:

  • Id (display number from 0 - number of displays)
  • Width (display width in px)
  • Height (display height in px)
  • X (display offset on X axis in px)
  • Y (display offset on Y axis in px)
  • Rotation (display rotation - number from 0 - 3):
    • 0: Portrait
    • 1: Landscape (90°)
    • 2: Portrait (180°)
    • 3: Landscape (270°)

• Options

  • Firmware (firmware number or name) - read only
  • RequestedFirmware (use this field to flash the device with new firmware)
  • Revision (hardware revision name)
  • PollingTime (get or set polling time for devices that use polling, otherwise it’s set to -1)
  • SleepSchedule (set when device will wake up - in minutes)
  • PeriodicSleep (set if sleep is periodic)
  • ScheduledWakeup (when device should wakeup) - read only

• Status (read only informations about device - all are optional)

  • Battery
  • Charger
  • RSSI
  • Temperature
  • ExternalBattery
  • ConnectReason
  • ConnectivityUsed
  • ErrorCode
  • NumSupportedDisplays
  • …

Devices Collection 

Device Configuration 

• TCLV (Type, Control, Length, Value) is a data protocol for machine to machine communication. Used for configuration and communication.

def get_tclv_list(key, secret, url, uuid):
            headers = {
                'Date': wsgiref.handlers.format_date_time(time.time()),
                'Content-Type': 'application/json'
            }
            h = hmac.new(secret, 'GET\n\n' + headers['Content-Type'] + '\n' + headers['Date'] + '\n/api/devicetclv/'+uuid, hashlib.sha256)
            headers['Authorization'] = key + ':' + base64.encodestring(h.digest()).strip()
            r = requests.get(url + 'api/devicetclv/'+uuid, headers=headers)
            return r.content

Device Configuration 

def get_tclv(key, secret, url, uuid, type):
                headers = {
                    'Date': wsgiref.handlers.format_date_time(time.time()),
                    'Content-Type': 'application/json'
                }
                tclv_to_send = '{"Data": [{"Type": '+int(type)+',"Control": 0, "Value": ""}]}'
                h = hmac.new(secret, 'POST\n\n' + headers['Content-Type'] + '\n' + headers['Date'] + '\n/api/api/cmd/Param/'+uuid, hashlib.sha256)
                headers['Authorization'] = key + ':' + base64.encodestring(h.digest()).strip()
                r = requests.post(url + 'api/cmd/Param/'+uuid, headers=headers, data=tclv_to_send)
                return r.json()

def set_tclv(key, secret, url, uuid, type, value):
                headers = {
                    'Date': wsgiref.handlers.format_date_time(time.time()),
                    'Content-Type': 'application/json'
                }
                tclv_to_send = '{"Data": [{"Type": '+int(type)+',"Control": 1, "Value": "'+str(value)+'"}]}'
                h = hmac.new(secret, 'POST\n\n' + headers['Content-Type'] + '\n' + headers['Date'] + '\n/api/cmd/Param/'+uuid, hashlib.sha256)
                headers['Authorization'] = key + ':' + base64.encodestring(h.digest()).strip()
                r = requests.post(url + 'api/cmd/Param/'+uuid, headers=headers, data=tclv_to_send)
                return r.json()

Reboot Device 

If device is online you can reboot it.

Reboot a list of Devices 

Session 

Session object contains settings for WebKit session.

It has the following attributes:

• Uuid (unique identifier)

• Options:

  • DefaultDithering (dithering method, it can be overriden with JS calls) - possible values:
    • none
    • bayer
    • floyd-steinberg
  • DefaultEncoding (default display mode) - posible values:
    • 1: black & white
    • 4: black & white + 14 shades of gray

• Backend:

  • Name (name of the used backend) - possible values:
    • HTML: (webkit HTML renderer)
    • HTTP: (simple backend that display images posted through http)
  • Fields (configuration fields for backend) - example:
    • url (session url for HTML backend) - It can contain {uuid} that will get replaced with Device Uuid.

Sessions Collection 

Restart Session 

This will reload WebKit session.

Restart a list of Sessions 

Clear session web cache 

User 

User object contains settings and credentials for users and API keys.

It has the following attributes:

• Username (username for login or API key)

• Password (hashed password or API secret)

• IsActive (determines if user/API key can access and modify data)

• IsAPI (determines if this object is user or API key)

Users Collection 

Configuration API gets and sets the server configuration.

Configuration 

Example configuration:

{
            "Global" : {
            "EmailConfig" : {
            "Sender"   : "koala@localhost",
            "Host"     : "localhost",
            "Port"     : "25",
            "Username" : "",
            "Password"  : ""
            },
            "AdminEmails" : [
            "xxx@yyy.com",
            "zzz@qqq.com"
            ],
            "MasterHost"     : "127.0.0.1",
            "OnCrash"        : "email",
            "DeploymentName" : "Example deployment",
            "DeploymentKey"  : "use uuidgen to generate",
            "ExposePolling"  : false,
        "PacketTimeout"  : 300,
        "AutoUpdater"    : 1,
        "AutoBootLoader" : 1,
        "PV3Securuty"    : 1,
        "DeviceStatePolling": 15,
        "DeferFirmwareUpdate": true,
        "DeferFirmwareTime": 0,
        "Timezone" : "Europe/London"
        },
        "Okular": {
            "RenderTimeout"  : 100,
            "FontAntialias"   : false,
            "WebkitRSSLimit" : 187,
            "WebkitUserAgent": "WebKit-VisionectOkular-1",
            "IgnoreInputIfDeviceNotSync": false,
            "MaxSessions"    : 100,
            "PageCaching"    : false,
            "Defaults": {
            "URI"            : "http://localhost:8000/uuid/{uuid}",
            "Encoding"       : 4,
            "Resolution"     : "600x800",
            "PageLayout"     : "0",
            "DitheringMethod": "none"
                }
            }
        }

Global

• EmailConfig: configure the email server to be used for important notifications from the Visionect Server,

• AdminEmails: an array to add recipient email addresses for email notifications,

• MasterHost: the host where Visionect Server is running,

• OnCrash: if set to email, a notification to all recipient addresses is sent if the Visionect Server fails (eg. in case of a program crash for some reason),

• DeploymentName: the name of the deployment,

• DeploymentKey: a unique identifier for the current Visionect Server installation. It is generated automatically upon installation,

• ExposePolling: enables control over polling from Network Manager. Dynamic polling is disabled by default, as it overrides the setting configured on the device,

• PacketTimeout: device protocol packet acknowledge timeout,

• AutoUpdater: automatically update device firmware when device connects,

• AutoBootUpdater: automatically update device bootloader when device connects,

• PV3Security: enable encrypted communication between VSS and device,

• DeviceStatePolling: VSS will periodically poll device to send status. This configuration tells VSS how often (in minutes) it should do it,

• DeferFirmwareUpdate: VSS will defer firmware upgrade for specified amount of time,

• DeferFirmwareTime: firmware defer time in seconds,

• Timezone: timezone configuration for VSS, HTML back-end will use this time zone for its JavaScript engine,

Okular

• RenderTimeout: How long HTML rendering engine (formerly Okular) should wait for a rectangle region (in milliseconds) to be rendered before preprocessing the data for the device. Longer intervals are usually needed for rectangles with complex graphics, or if running HTML rendering engine on a slow machine,

• FontAntialias: configures if the fonts displayed on the device should be anti-aliased by the standard GTK+ anti-aliasing process. Set to disabled if you’re using your pixel perfect fonts,

• WebKitRSSLimit: now called Web Session Memory Limit; it set an upper limit of available RAM memory (in MiB) that a webkit instance should use. If the limit is reached, the session is restarted. This protects the system from running out of memory in case of a memory leak in the application,

• WebkitUserAgent: configure the HTTP user agent header, so that the web applications can detect the presence of HTML rendering engine and reconfigure accordingly,

• IgnoreInputIfDeviceNotSync: ignores any new click requests from the device in case there’s unsent data in the device session. This means new clicks won’t affect the application and the old response will be sent instead,

• MaxSessions: maximum number of sessions for the HTML rendering engine. New session requests will be ignored if the number exceeds the limit,

• PageCaching: should the loaded pages and resources be cached,

• Defaults: default settings for devices that connect for the first time,

  • URI: the default URI to open,
  • Encoding: now called Bit depth; it configures the default display bit-depth. Valid values are 1 and 4. 1-bit encoding reduces the refresh rate to 250msec (E Ink technology limitation), while 4-bit is the maximum bit depth. This value can be overridden by HTML rendering backend (formerly Okular) Javascript Extensions in the web application,
  • Resolution: display resolution to use,
  • PageLayout: now called Display rotation; it is default screen rotation. Relevant if device screen autodetection fails. Available options are: 0 (no rotation), 1 (90-degree rotation), 2 (180-degree rotation), 3 (270-degree rotation)
  • DitheringMethod: every web page has to be converted from color to grayscale or black and white (according to the Graphics Engine setting). You can choose the type of dithering based on performance and quality requirements. Currently supported (in order of quality): none, bayer and floyd-steinberg. Noise dithers will not be supported, as they negate the Graphics Engine render caching infrastructure.

Live View 

Device status 

HTTP Backend 

This only works for devices that have HTTP backend selected in settings.

List of problematic sessions