snippets

The snippets folder contains portions of buildfiles that mkqnximage uses to create partitions for the SD card image generated by the project build. The mkqnximage utility combines these files with boilerplate snippets to assemble full buildfiles (.build), that are required to generate partition files (.part) files for the image generation process.

The project currently contains the following snippets:

SnippetAbout
boot_files.customControls which extra files are incorporated into the boot partition. Refer to the "boot" section for details on what boot customizations are possible to make with respect to these files. No other changes should be required with this snippet at this time.
data_files.customAdds in configuration files for various services running on the device. Customizations may be required here if a new service is ported and integrated, and it requires a configuration file under /data/var.
data_files.develIncludes entries for the user home directories and some local user configuration files.

If a new utility is integrated and it can benefit for a default local configuration files, the local configuration entries can be added here for each user account that requires them.

If a new user account is added, extra entries would need to be added here to create the new user folder and extra configuration files.

See the entries for qnxuser as an example of what entries to add for another user.

definitions.type_raspi_patchAdds some low level driver definitions to the build. No customizations require changing this snippet at this time.
group_file.develContains entries that are added to /etc/group during the build. Any customizations to user group membership should be manipulated here. Refer to the note at the end of the "Display resolution" section as an example change that could be made in this snippet.
ifs_files.customContains entries for configuring and launching the USB launcher service.

No customizations require adjusting its content at this time.

ifs_start.10.customThis snippet serves two roles:
  • Creates symbolic links to map system partition path to paths typically found on Linux where certain folders are expected to be located. New entries typically would be added here for some new open source integrations. A couple of entries were also added for the asset integrations already included in the project.
  • Entries are added here to set some global environment variables for certain services integrated into the image.
post_start.customContains extra commands to add into the startup script found at /system/etc/startup/post_startup.sh, once the device is booted up.

Some desktop customizations described below will involve editing this snippet. A new open source service that is integrated, that would need to be started at boot, would require changes to this snippet as well to add the startup commands to the boot sequence.

profile.customContains extra environment variables or entries to add into /system/etc/profile, to add global environment variables to each user's environment when they start a new shell.

A new open source service that is integrated, that would need environment variables to be defined to operate, would require changes to this snippet.

system_files.customMerged into the system partition buildfile, and serves as a general location where extra entries for files to be integrated into the system partition can be added. Extra snippets where subsets of entries are added following a specific theme or service will be covered below.

For extra integrations, the user has a choice to update this snippet with extra system entries or create a subset snippet to do so.

system_files.custom.camera_demoMerged into the system buildfile, but it contains entries related to sensor framework and camera libraries and sample apps, mainly to make it easier to locate and differentiate from other integrations that may be modified less often.
system_files.custom.graphicsMerged into the system buildfile, but it contains entries related to graphics and fonts. This snippet will evolve in future releases of this project but is not expected to be customized too much by end users.
system_files.custom.post_startupContains entries for new scripts added that are called by post_startup.sh.

No customizations are expected to this file at this time.

system_files.custom.rpi_gpioContains entries for new entries added to integrate the GPIO resource manager and gpioctrl utility and GPIO sample Python code.

No customizations are expected to this file at this time.

system_files.custom.SDLContains entries for new entries added to integrate the SDL libraries currently integrated into this project.

Updates are expected to this snippet in future releases, but end users can modify this snippet if they want to integrate extra SDL projects on their own.

system_files.custom.window_managersContains entries relating to the two window managers integrated into the project, as well as their assets and configuration files.

Updates may be made to this snippet in future releases, but end users can modify this snippet as per customization options that will be described in following sections.

wifi.custom (Optional)If this snippet is added, it can contain a network block that can get injected into the wpa_supplicant.conf file for Wi-Fi settings.

Refer to the "Wi-Fi" section of the QSTI chapter for more details on how to populate the file.

Note that this method of setting Wi-Fi settings isn't recommended unless your image is slated for devices that are operating in a fixed environment, such as a school or corporate lab, or a guest network, as opposed to an image being shared with others in the developer community abroad.

Page updated: