Skip to content

Commit 3e60fd8

Browse files
author
Pavel Petroshenko
authored
Merge pull request #8 from electricimp/develop
v0.1.1
2 parents 7d48c0c + 758e2e4 commit 3e60fd8

File tree

5 files changed

+18
-25
lines changed

5 files changed

+18
-25
lines changed

Diff for: README.md

+15-22
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Electric Imp impCentral Microsoft Visual Studio Code Extension (Alpha) #
22

3-
| This extension is in the Alpha state. Please report any issues that you find. <br/>Thanks for your patience and cooperation! |
3+
| This extension is in the Alpha state. Please report any issues that you find. Thanks for your patience and cooperation! |
44
| --- |
55

66
## Contents ##
@@ -20,7 +20,7 @@
2020
- [The Log Console](#the-log-console)
2121
- [Assign A Device To The Project Device Group](#assign-a-device-to-the-project-device-group)
2222
- [Unassign A Device From The Project Device Group](#unassign-a-device-from-the-project-device-group)
23-
- [Retrieve A Device’s Agent URL](#retrieve-a-devices-agent-url)
23+
- [Retrieve An Agent URL](#retrieve-an-agent-url)
2424
- [Extension Keyboard Shortcuts](#extension-keyboard-shortcuts)
2525
- [Pre-processor And Multiple File Support](#pre-processor-and-multiple-file-support)
2626
- [Specify GitHub Authentication Information](#specify-github-authentication-information)
@@ -66,14 +66,7 @@ The Electric Imp Visual Studio Code Extension can be installed using any of a nu
6666

6767
#### Installation From The Visual Studio Marketplace ####
6868

69-
The [Visual Studio Marketplace](https://marketplace.visualstudio.com/VSCode) can be accessed through Visual Studio Code itself.
70-
Please refere to the Marketplace [documentation](https://code.visualstudio.com/docs/editor/extension-gallery) for more details.
71-
Search for "Electric Imp Squirrel" extension and click the "Install" button next to it.
72-
73-
#### Installation From A .VSIX File ####
74-
75-
1. Download the `.vsix` file from [Electric Imp’s GitHub repository](https://github.com/electricimp/vscode).
76-
2. Enter the following at the command line: `code --install-extension vscode-electricimp-X.X.X.vsix`
69+
The [Visual Studio Marketplace](https://marketplace.visualstudio.com/VSCode) can be accessed through Visual Studio Code itself. Please refer to the Marketplace [documentation](https://code.visualstudio.com/docs/editor/extension-gallery) for more details. Search for the extension using `"Electric Imp Squirrel"` and, when the extension is listed, click the **Install** button next to it in the search results.
7770

7871
#### Installation From Source ####
7972

@@ -132,16 +125,16 @@ The `imp.config` file contains:
132125
- A unique user identifier.
133126
- A unique Device Group identifier.
134127
- Device and agent code file names.
135-
- [Builder](https://github.com/electricimp/Builder) settings.
128+
- [Builder](https://developer.electricimp.com/tools/builder) settings.
136129

137130
#### Example ####
138131

139132
```json
140-
{ "ownerID" : "<user id>",
141-
"deviceGroupId" : "<device group id>",
142-
"device_code" : "<path to device source file; src/device.nut by default>",
143-
"agent_code" : "<path to agent source file; src/agent.nut by default>",
144-
"builderSettings": "<different Builder variables>" }
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>",
137+
"builderSettings" : "<different Builder variables>" }
145138
```
146139

147140
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.
@@ -181,9 +174,9 @@ To assign devices to the project’s Device Group, select **View > Command Palet
181174

182175
Devices can be removed from the project’s Device Group by selecting **View > Command Palette... > imp: Remove Device from current DG**.
183176

184-
### Retrieve A Device’s Agent URL ###
177+
### Retrieve An Agent URL ###
185178

186-
The URL of a device’s agent can be retrieved by selecting **View > Command Palette... > imp: Get agent URL**. The URL is displayed in a dialog box and copied to clipboard.
179+
The URL of a device’s agent can be retrieved by selecting **View > Command Palette... > imp: Get agent URL**. The URL is displayed in a dialog box and copied to the clipboard.
187180

188181
### Extension Keyboard Shortcuts ###
189182

@@ -211,7 +204,7 @@ Please use the project `<project working directory>/settings/auth.info` file to
211204

212205
### Specify Builder Preset Variable Definitions ###
213206

214-
Please use the project `<project working directory>/settings/imp.config` file to specify Builder variable definitions like [here](https://github.com/electricimp/Builder#types).
207+
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)).
215208

216209
```json
217210
{ "builderSettings": { ...,
@@ -229,13 +222,13 @@ Please use the project `<project working directory>/settings/imp.config` file to
229222

230223
It is possible to obtain these Builder variable definitions values from Squirrel code this way:
231224

232-
```
225+
```squirrel
233226
server.log(@{IntType}); // 34
234227
server.log(@{FloatType}); // 34.456
235228
server.log(@{ExponentType1}); // 30000
236229
server.log(@{ExponentType2}); // 0.03
237-
server.log("@{StringType1}"); // str1
238-
server.log(@{StringType2}); // str2
230+
server.log(@{StringType1}); // str1
231+
server.log(@{StringType2}); // "str2"
239232
server.log(@{BoolTypeTrue}); // true
240233
server.log(@{BoolTypeFalse}); // false
241234
server.log(@{NullType}); // (null : 0x0)

Diff for: package-lock.json

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "vscode-electricimp",
33
"displayName": "Electric Imp Squirrel",
44
"description": "Electric Imp Application Development",
5-
"version": "0.1.0",
5+
"version": "0.1.1",
66
"publisher": "electricimp",
77
"icon": "simple_nut.png",
88
"license": "MIT",
@@ -161,6 +161,6 @@
161161
},
162162
"repository": {
163163
"type": "git",
164-
"url": "https://github.com/blablacar/vscode-squirrel-lang.git"
164+
"url": "https://github.com/electricimp/vscode.git"
165165
}
166166
}

Diff for: vscode-electricimp-0.1.0.vsix

-3.79 MB
Binary file not shown.

Diff for: vscode_icon.png

3.78 KB
Loading

0 commit comments

Comments
 (0)