Uploading Blueprint

Web IDE

The process of uploading your Blueprint using Web IDE is pretty straightforward. Choose your UCM from the list and the process will start. Enapter Cloud will update your device's specifications internally and will send Lua script to the UCM.

Click Upload to Device and choose your UCM from the list

Uploading will start, it usually takes few seconds

CLI

Enapter CLI is convenient cross-platform tool for Mac OS X, Windows and Linux for management of Enapter services, including Blueprints. It is very handy when text editor or desktop IDE such as VS Studio Code are used to develop and upload Blueprints. Without Enapter CLI you would have to copy and paste your files into Web IDE.

The tool is provided as open-source software and available in both source code and binaries at GitHub. If you are lucky user of Mac OS, Enapter CLI can be installed with Homebrew which will help to ensure proper upgrade:

brew tap enapter/tap && brew install enapter

Otherwise install it from source or use official binaries.

Doesn't matter which OS you are using Enapter CLI requires access token for authentication. Getting a token is easy and can be done by following a few steps.

1. Ensure you have registered Enapter Cloud account. If not, sign up here.
2. Log in to your Enapter Cloud account, click on your profile name in top right corner and choose Account Settings.
3. Select API Tokens menu and click New Token button.
4. Follow the instructions on the screen.

Enter your Token name and click Create Token button

Important Information

Please note that if you don't save your token, it is not possible to reveal it anymore. You need to generate a new token.

To upload the Blueprint to the UCM you need to know your UCM ID. You can find it either on the About screen in the mobile application (click on UCM ID to copy), or on the device screen in Enapter Cloud (click on the ID to copy).

Pass your API token(via environment variable), UCM hardware ID, and the current directory (. in command line) as a Blueprint directory to enapter CLI command.

export ENAPTER_API_TOKEN=<YOUR API TOKEN>
enapter devices upload --hardware-id <UCM ID> --blueprint-dir .

Uploading will start, it usually takes few seconds

Once the process is finished, UCM will start sending sample telemetry we specified in the Lua script and will wait for your commands. You are now ready to explore your device! 🎉

💬 Need Help?

Have a question or hit a roadblock? Join the Enapter Discord community to get quick support, exchange ideas, and collaborate with other developers and energy experts.