Current Version: 2.1.0
This Sublime Text 3 Plug-in for Electric Imp applications development is designed to improve developer productivity. It allows you to rapidly build and maintain applications by providing:
For operation, the Extension requires a connection to the Internet. It also requires Node.js, impWorks Builder and Sublime Text 3.
IMPORTANT The Electric Imp Sublime Plug-in supports Sublime Text 3 only. No other versions are supported. Tested on macOS only.
Note The Plug-in requires Node.js 4.0 or above.
Please follow these instructions to install Node on your machine.
The Plug-in uses the Builder Node.js module for source code pre-processing. To install Builder, please use Node Package Manager (NPM):
npm i -g Builder
Sublime Text 3 can be downloaded for a variety of platforms here.
If you already have Package Control installed in Sublime Text:
"Electric Imp Developer" and click Enter.You can install the Plug-in with the following command in the Sublime Text terminal (Ctrl+`) which utilizes git clone.
Note Please make sure you have git installed on your system before trying this method.
import os; path=sublime.packages_path(); ie_plugin_path=os.path.join(path, 'imp-developer'); (os.makedirs(path) if not os.path.exists(path) else None); window.run_command('exec', {'cmd': ['git', 'clone', 'https://github.com/electricimp/ElectricImp-Sublime.git', 'imp-developer'], 'working_dir': path}) if not os.path.exists(ie_plugin_path) else window.run_command('exec', {'cmd': ['git', 'pull'], 'working_dir': ie_plugin_path})
Alternatively, follow these steps to install the Plug-in manually:
Create the Plug-in folder:
Do one of the following:
Restart Sublime Text 3.
Your first step should be the creation of a new project. Do this by selecting the Tools > Packages > Electric Imp > Create Project menu item. You will then be asked to specify the project directory.
The project directory will be set up with the following:
-- <project directory>
|----> settings - Plug-in settings directory
. |--> auth.info - SENSITIVE impCentral™ API tokens and
. | GitHub authentication information
. |--> electric-imp.settings - Generic Electric Imp settings
.
|----> src - Source code directory
. |--> device.nut - Device code file
. |--> agent.nut - Agent code file
.
|----> .gitignore - .gitignore file to exclude auth.info file
| from the git repository
|----> electric-imp.sublime-project - Sublime project file
IMPORTANT The settings/auth.info file should not be put under source control as it contains sensitive information. A .gitignore file is included automatically to prevent this.
The electric-imp.settings file contains:
{ "product-id" : "<product id>",
"devicegroup-id" : "<device group id>",
"deployment-id" : "<deployment id>",
"device-file" : "<path to device source file, src/device.nut by default>",
"agent-file" : "<path to agent source file, src/agent.nut by default>",
"cloud-url" : "<impCentral base endpoint URL>",
"builder-settings": { "variable-definitions": {<Builder variable definitions>},
"builder_cli_path" : "<Path to Builder's cli.js>",
"node_path" : "<path to Node.js executable>" }}
When a project is created, empty device and agent code files (device.nut and agent.nut, respectively) are automatically created and stored in the project directory’s src sub-directory.
If a project is created successfully, a new window with the project directory is opened.
.nut, please make sure you have Squirrel (Electric Imp) language selected under View > Syntax.To open an existing Electric Imp project, select Project > Open Project... and choose the
<project directory>.sublime-project file from your project directory.
Note The Plug-in won’t detect an Electric Imp project if it is opened as a folder (File > Open...) rather than as a Sublime Text project.
To build and deploy code, select Tools > Packages > Electric Imp > Build and Run. This action uploads the agent and the device code to the server, and restarts all of the devices assigned to the target Device Group.
When you first build code (or perform any other action that requires access to the impCloud), you will be asked to provide:
You may also be offered the opportunity to download the latest deployment if you select an existing Product and Device Group.
If you want to have you code running on a specific devices and view the logs from those devices, you need to select them using Tools > Packages > Electric Imp > Assign Device. The Unassign Device menu item removes a device from the project’s Device Group.
Note To build and deploy your code it isn’t necessary to assign a device to the Device Group. If you don’t have a device assigned, you can still work on the code and see compilation errors reported by the server.
The Console can be popped up by selecting Tools > Packages > Electric Imp > Show Console. The Console shows live logs streamed from the current Device Group if the group contains at least one device.
To assign devices to the project’s Device Group, go to Tools > Packages > Electric Imp > Assign Device menu item and select a device from the list. The newly added device is automatically attached to the Console log stream.
Devices can be removed from the project’s Device Group by selecting Tools > Packages > Electric Imp > Unassign Device.
Note The log will be restarted when a device is unassigned.
The URL of a device’s agent can be retrieved by selecting Tools > Packages > Electric Imp > Get Agent URL. The URL is saved to the clipboard.
Note Electric Imp-specific menu items are only available if an Electric Imp project is opened in the currently active window.
| Command | Shortcut |
|---|---|
| Create Project | Ctrl + Shift + Y |
| Build and Run | Ctrl + Shift + X |
| Show Logs Console | Ctrl + Shift + C |
Please refer to the Builder documentation for more information on the pre-processor syntax that you can use in your Squirrel code.
Please use the <project directory>/settings/auth.info file to specify your Builder GitHub authentication information:
{ ...
"builder-settings": { "github-user" : "GitHub user name",
"github-token": "Personal access token or password" }}
Please use the <project directory>/settings/electric-imp.settings file to specify Builder variable definitions (as described here):
{ "builder-settings": { ...,
"variable-definitions": { "key1": "value1",
"key2": "value2" },
... }}
The Electric Imp Sublime Plug-in is licensed under the MIT License.