balena-sdk/es2018/models/balenaos-contract.js

The Balena JavaScript SDK

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.aliases = exports.BalenaOS = void 0;
// Hardcoded host OS contract, this should be moved to the Yocto build process with meta-balena.
// Here for initial implementatin and testing purposes
exports.BalenaOS = {
    name: 'balenaOS',
    slug: 'balenaos',
    type: 'sw.os',
    description: 'Balena OS',
    partials: {
        image: [`{{#each deviceType.partials.instructions}}{{{this}}} {{/each}}`],
        internalFlash: [
            `{{#each deviceType.partials.connectDevice}}{{{this}}} {{/each}}`,
            `Write the {{name}} file you downloaded to the {{deviceType.name}}. We recommend using [Etcher](https://etcher.balena.io/).`,
            `Wait for writing of {{name}} to complete.`,
            `{{#each deviceType.partials.disconnectDevice}}{{{this}}} {{/each}}`,
            `{{{deviceType.partials.bootDevice}}} to boot the device.`,
        ],
        externalFlash: [
            `{{#each deviceType.partials.instructions}}{{{this}}} {{/each}}`,
            `Insert the {{resolveContractAlias deviceType.data.media.altBoot.[0]}} to the host machine.`,
            `Write the {{name}} file you downloaded to the {{resolveContractAlias deviceType.data.media.altBoot.[0]}}. We recommend using [Etcher](https://etcher.balena.io/).`,
            `Wait for writing of {{name}} to complete.`,
            `Remove the {{resolveContractAlias deviceType.data.media.altBoot.[0]}} from the host machine.`,
            `Insert the freshly flashed {{resolveContractAlias deviceType.data.media.altBoot.[0]}} into the {{deviceType.name}}.`,
            `<strong role="alert">Warning!</strong> This will also completely erase internal storage medium, so please make a backup first.`,
            `{{#each deviceType.partials.bootDeviceExternal}}{{{this}}} {{/each}}`,
            `Wait for the {{deviceType.name}} to finish flashing and shutdown. {{#if deviceType.partials.flashIndicator}}Please wait until {{deviceType.partials.flashIndicator}}.{{/if}}`,
            `Remove the {{resolveContractAlias deviceType.data.media.altBoot.[0]}} from the {{deviceType.name}}.`,
            `{{#each deviceType.partials.bootDeviceInternal}}{{{this}}} {{/each}}`,
            `{{{deviceType.partials.bootDevice}}} to boot the device.`,
        ],
        externalBoot: [
            `Insert the {{resolveContractAlias deviceType.data.media.defaultBoot}} to the host machine.`,
            `Write the {{name}} file you downloaded to the {{resolveContractAlias deviceType.data.media.defaultBoot}}. We recommend using [Etcher](https://etcher.balena.io/).`,
            `Wait for writing of {{name}} to complete.`,
            `Remove the {{resolveContractAlias deviceType.data.media.defaultBoot}} from the host machine.`,
            `Insert the freshly flashed {{resolveContractAlias deviceType.data.media.defaultBoot}} into the {{deviceType.name}}.`,
            `{{{deviceType.partials.bootDevice}}} to boot the device.`,
        ],
        jetsonFlash: [
            `To provision {{deviceType.name}}, follow the instructions using our [Jetson Flash tool](https://github.com/balena-os/jetson-flash/blob/master/docs/{{deviceType.slug}}.md) to make the process more streamlined.`,
        ],
        usbMassStorage: [
            `{{#each deviceType.partials.instructions}}{{{this}}} 
			{{/each}}`,
        ],
        edisonFlash: {
            Linux: [
                `{{#each deviceType.partials.Linux.flashDependencies}}{{{this}}} {{/each}}`,
                `Unplug the {{deviceType.name}} from your system`,
                `Unzip the downloaded {{name}} file`,
                `{{#each deviceType.partials.Linux.flashInstructions}}{{{this}}} {{/each}}`,
                `Plug the {{deviceType.name}} as per the instructions on your terminal.`,
                `You can check the progress of the provisioning on your terminal.`,
            ],
            MacOS: [
                `{{#each deviceType.partials.MacOS.flashDependencies}}{{{this}}} {{/each}}`,
                `Unplug the {{deviceType.name}} from your system`,
                `Unzip the downloaded {{name}} file`,
                `{{#each deviceType.partials.MacOS.flashInstructions}}{{{this}}} {{/each}}`,
                `Plug the {{deviceType.name}} as per the instructions on your terminal.`,
                `You can check the progress of the provisioning on your terminal.`,
            ],
            Windows: [
                `{{#each deviceType.partials.Windows.flashDependencies}}{{{this}}} {{/each}}`,
                `Unplug the {{deviceType.name}} from your system`,
                `Unzip the downloaded {{name}} file`,
                `{{#each deviceType.partials.Windows.flashInstructions}}{{{this}}} {{/each}}`,
                `Plug the {{deviceType.name}} as per the instructions on your terminal.`,
                `You can check the progress of the provisioning on your terminal.`,
            ],
        },
    },
};
exports.aliases = {
    sdcard: 'SD card',
    usb_mass_storage: 'USB key',
};