Skip to main content

Maintenance API

Provides maintenance functions for privileged users

maintenance.calibrate​

Signatures​

calibrate()

Description​

Calibrate the device.

Only TVs will be calibrated, other types of devices will be ignored.

See also Sidecar.Calibration.calibrate/3

maintenance.display_image_from_url​

Signatures​

display_image_from_url(url)

Description​

Downloads and displays an image from a URL.

Returns a table with:

  • success: boolean indicating if the operation was successful
  • path: path to the downloaded image file (if successful)
  • error: error message (if unsuccessful)

Example​

local result = maintenance.display_image_from_url("https://example.com/image.jpg")

maintenance.fisheye​

Signatures​

fisheye(params)

Description​

Update the distortion model for the fisheye camera.

Example​

maintenance.fisheye({
  matrix = {
    cx = 948.2805634981071,
    cy = 547.3677679389784,
    fx = 806.9338359737485,
    fy = 806.262431744419
  },
  distortion = {
    k1 = -0.011471216865893835,
    k2 = -0.007111452987309034,
    k3 = 0.010281834316738276,
    k4 = -0.005961512364417588
  }
})

maintenance.fisheye_preset​

Signatures​

fisheye_preset(name)

Description​

Update the distortion model for the fisheye camera.

Example​

maintenance.fisheye_preset("rokinon_fe75mft")

maintenance.homography​

Signatures​

homography(params)

Description​

Update the homography for the device.

Example​

maintenance.homography({matrix = { h00 = 0, h01 = -1, h02 = -1, h10 = 1, h11 = 0, h12 = 0, h20 = 0, h21 = 0, h22 = 0.5 }})

maintenance.screen_brightness​

Signatures​

screen_brightness(brightness)

Description​

Update screen brightness for the device.

maintenance.screen_brightness_mode​

Signatures​

screen_brightness_mode(mode)

Description​

Update screen brightness mode for the device.