You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-10
Original file line number
Diff line number
Diff line change
@@ -62,7 +62,7 @@ Visual Studio Code can be [downloaded for a variety of platforms here](https://c
62
62
63
63
### 4. Install The Visual Studio Code Extension ###
64
64
65
-
The Electric Imp Visual Studio Code Extension can be installed using any of a number of methods, listed below. Once the Extension has been published to the [Visual Studio Marketplace](https://marketplace.visualstudio.com/VSCode), this will be the recommended way to install the Extension, but you may alternatively perform the install using a `.vsix` file or by building the Extension from the source code.
65
+
The Electric Imp Visual Studio Code Extension can be installed using any of a number of methods, listed below. Once the Extension has been published to the [Visual Studio Marketplace](https://marketplace.visualstudio.com/VSCode), this will be the recommended way to install the Extensionby building it from the source code.
66
66
67
67
#### Installation From The Visual Studio Marketplace ####
68
68
@@ -101,6 +101,14 @@ The Extension provides the following commands:
101
101
102
102
Select a new project working directory using **File > Open Folder...**, if you have not done so. Select the **View > Command Palette... > imp: New Project** menu item.
103
103
104
+
When you create new project (or perform any other action that requires access to the impCloud), you will be asked to:
105
+
106
+
- Provide your impCentral API base URL. The default value should be used, unless you are working with a private Electric Imp cloud.
107
+
- Provide your Electric Imp account user name, password and one-time password (OTP) as needed.
108
+
- Specify whether a new Product should be created or an existing one selected for the project.
109
+
- Select an impCentral account for the project from a list of accounts available for the user. Please see [Collaboration](https://developer.electricimp.com/tools/impcentral/collaboratoractions) for more details.
110
+
- Specify whether a new Device Group should be created or an existing one selected for the project.
111
+
104
112
The project directory will be set up with the following files and structure:
105
113
106
114
```
@@ -130,11 +138,12 @@ The `imp.config` file contains:
130
138
#### Example ####
131
139
132
140
```json
133
-
{ "ownerID" : "<user id>",
134
-
"deviceGroupId" : "<device group id>",
135
-
"device_code" : "<path to device source file; src/device.nut by default>",
136
-
"agent_code" : "<path to agent source file; src/agent.nut by default>",
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 working directory’s `src` sub-directory.
@@ -144,7 +153,7 @@ If the project was created successfully, the `imp.config` file is opened.
144
153
#### Important Notes ####
145
154
146
155
- If the project working directory is not open in Visual Studio Code, no Extension commands will work. Use **File > Open Folder...** to open the directory.
147
-
- The code which is deployed to a Device Group is preprocessed and therefore may contain line control markers.
156
+
- The code which is deployed to a Device Group is pre-processed and therefore may contain line control markers.
148
157
- When you select an existing Device Group, the Extension downloads the code currently deployed to the group, but doesn’t transfer this code to the project file/directory structure.
149
158
- If you are working with collaborators on a project, please share the original Electric Imp Extension project sources/structure via a source control system.
150
159
@@ -190,11 +199,11 @@ The URL of a device’s agent can be retrieved by selecting **View > Command Pal
190
199
191
200
## Pre-processor And Multiple File Support ##
192
201
193
-
Please refer to the [Builder documentation](https://developer.electricimp.com/tools/builder) for more information on the preprocessor syntax that you can use in your Squirrel code.
202
+
Please refer to the [Builder documentation](https://developer.electricimp.com/tools/builder) for more information on the pre-processor syntax that you can use in your Squirrel code.
194
203
195
204
### Specify GitHub Authentication Information ###
196
205
197
-
Please use the project `<project working directory>/settings/auth.info` file to specify your Builder GitHub authentication information:
206
+
Please use the `<project working directory>/settings/auth.info` file to specify your Builder GitHub authentication information:
198
207
199
208
```json
200
209
{ ...,
@@ -204,7 +213,7 @@ Please use the project `<project working directory>/settings/auth.info` file to
Please use the project `<project working directory>/settings/imp.config` file to specify Builder variable definitions (as [described here](https://developer.electricimp.com/tools/builder#builder-expressions)).
216
+
Please use the `<project working directory>/settings/imp.config` file to specify Builder variable definitions (as [described here](https://developer.electricimp.com/tools/builder#builder-expressions)).
0 commit comments