Connect Applet to device with signageOS CLI

Fast track your development with instant deployment of your Applet directly from CLI to selected device in your local network.

Prerequisites

Tech stack

You need the following stack to get started with your development:

• signageOS Account

• having at least one Organization in the Box (create one here)

• Node.js >= 10.15.0 with NPM included in the file package. The latest stable Node version you can find on the following site: https://nodejs.org/en/download/
  If necessary, the previous Node releases can be found on the site: https://nodejs.org/en/download/releases/

• Shell, Gitbash, Powershell, Windows Terminal or Cmder.

TIP: Windows Terminal and Cmder allows open more than one console window which can be helpful in the daily development work.

1. signageOS CLI

• Install signageOS CLI npm install @signageos/cli@latest -g
• Login with CLI sos login
• Set default Organization sos organization set-default

2. Code your project

Build from scratch

3. Build Applet

• navigate to your Applet's folder and run command npm run build to finish the Applet building process.

• Alternatively, when you use your own coded Applet you perform your specific command to build your project.

4. Upload Applet to Box

• To use sos device connect you have to add Applet information (appletUid, appletVersion) to package.json. The correct way is to run the upload command:

sos applet upload

• Command will upload your Applet to signageOs Box and will allow sending the Applet to the device directly from CLI

5. Install the latest Core App on your device

To use this feature, you need at least the following versions of Core App on your displays:

TIP: How to update Core App in Box or REST API

Using sos device connect

• If you performed all steps described above you are ready to send your Applet to selected device within your local network.

• You should be in root folder of your Applet project when running the command to connect to a device:

  sos device connect
  

  • You can pass these arguments after command, or the command will provide you with interactive selection

• It may take several seconds before the Applet is displayed on your device

• To exit the development mode press CTRL + C or CMD + C while you are in your terminal. This command will stop the connection and the content on the display should return to previous state.

Applet auto-reload 

• This feature is available only when you use our webpack plugin in your project. Plugin is automatically installed in applets generated via CLI's command sos applet generate

• In one terminal you perform sos device connect and in another window you run npm run connect (you have to be in the Applet directory in both terminals) 

• Alternatively, if you want to display changes you need to stop sos device connect -> build your Applet -> perform sos device connect