SimpleSwitch™ packages#

inherit simpleswitch-package

will turn a recipe into a SimpleSwitch™ package. This package can be used with simpleswitch-helper.

Options explained#

Add a SimpleSwitch™ launcher human readable description#

To have a well formatted description you can place a file <package name>-description.md.jinja next to the recipe itself and the build process will take the content of that file.

e.g. for simpleswitch-example.bb this file should be called simpleswitch-example-description.md.jinja

The file can contain a markdown with Jinja templating code.

As variables the following can be used

web (boolean) - launcher is run in web-mode
installed (list of str) - SimpleSwitch™ packages installed on the target
ip (str) - IP address of the device (or empty if no connection is established yet)

Install on the target#

After building the new SimpleSwitch™ package, you need to transfer the artifacts to the your device. On your computer run

Scotty
bitbake

   package=<name of your SimpleSwitch™ package>
   board_ip=<IP of your device>
   scotty devtool simpleswitch-install-target ${package} ${board_ip}

   package=<name of your SimpleSwitch™ package>
   board_ip=<IP of your device>
   devtool simpleswitch-install-target ${package} ${board_ip}

to uninstall a package run

Scotty
bitbake

   package=<name of your SimpleSwitch™ package>
   board_ip=<IP of your device>
   scotty devtool simpleswitch-uninstall-target ${package} ${board_ip}

   package=<name of your SimpleSwitch™ package>
   board_ip=<IP of your device>
   devtool simpleswitch-uninstall-target ${package} ${board_ip}

to restore the factory default of the image, just run

Scotty
bitbake

   package=<name of your SimpleSwitch™ package>
   board_ip=<IP of your device>
   scotty devtool simpleswitch-restore-target ${board_ip}

   package=<name of your SimpleSwitch™ package>
   board_ip=<IP of your device>
   devtool simpleswitch-restore-target ${board_ip}

or to take screenshots of the package at different resolutions run

bitbake

   package=<name of your SimpleSwitch™ package>
   board_ip=<IP of your device>
   resolutions=<list of the resolutions formated as {width}x{height} or as {width}x{height}@{refresh_rate}>
   destination=<directory where the screenshots are saved>
   time=<time to wait before taking the screenshot as some package take some time to be fully loaded>
   dependencies=<dependencies needed for the package>
   devtool simpleswitch-screenshot-target ${package} ${board_ip} --resolutions ${resolutions} --destination ${destination --time ${time} --dependencies ${dependencies}

Here are the default values for the screenshot arguments:

resolutions: 800x480 1280x800 1920x1080
destination: sources/simplecore-distro/meta-simpleswitch/lib/oeqa/files/images/<package>
time: 60
dependencies: None

If the screenshot is specific to the machine, the baseboard or the display (for example HDMI), these arguments can be used:

--machine: It adds the name of the machine in the screenshot’s name.
--baseboard: It adds the name of the baseboard in the screenshot’s name.
--display: It adds hdmi to the screenshot’s name if the used display is HDMI.