diff --git a/README.md b/README.md index 3e10e70..3884a6a 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,75 @@ -# azure-iot-toolkit README +# Code Runner -This is the README for your extension "azure-iot-toolkit". After writing up a brief description, we recommend including the following sections. +Toolkit makes Azure IoT Development easier ## Features -Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. +[*] Send messages to Azure IoT Hub (device-to-cloud message) -For example if there is an image subfolder under your extension project workspace: +[*] Monitor device-to-cloud messages -\!\[feature X\]\(images/feature-x.png\) +[ ] Send messages from Azure IoT Hub to device (cloud-to-device message) -> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow. +[ ] Device management (List, Create, Update, Delete) -## Requirements +[ ] And more... -If you have any requirements or dependencies, add a section describing those and how to install and configure them. +## Commands -## Extension Settings +| Command | Keyboard Shortcuts | Menu Contexts | +| -- | -- | -- | +| Send message to IoT Hub | Ctrl+Alt+F9 | editor/context | +| Start monitoring | Ctrl+Alt+F10 | editor/context | +| Stop monitoring | Ctrl+Alt+F11 | editor/context | -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. +## Usages -For example: +* Send messages to Azure IoT Hub -This extension contributes the following settings: +![Usage](images/send.gif) -* `myExtension.enable`: enable/disable this extension -* `myExtension.thing`: set to `blah` to do something +* Monitor device-to-cloud messages -## Known Issues +![Usage](images/monitor.gif) -Calling out known issues can help limit users opening duplicate issues against your extension. +## Configuration -## Release Notes +To set the Device Connection String which is used to send device-to-cloud message: +```json +{ + "azure-iot-explorer.deviceConnectionString": "HostName=.azure-devices.net;DeviceId=;SharedAccessKey=" +} +``` -Users appreciate release notes as you update your extension. +To set the IoT Hub Connection String to monitor device-to-cloud message: +```json +{ + "azure-iot-explorer.iotHubConnectionString": "HostName=.azure-devices.net;SharedAccessKeyName=;SharedAccessKey=" +} +``` -### 1.0.0 +To set the IoT Hub Consumer Group (default is "$Default"): +```json +{ + "azure-iot-explorer.consumerGroup": "$Default" +} +``` -Initial release of ... +## Telemetry data +By default, anonymous telemetry data collection is turned on to understand user behavior to improve this extension. To disable it, update the settings.json as below: +```json +{ + "azure-iot-explorer.enableAppInsights": false +} +``` -### 1.0.1 +## Change Log +### 0.0.1 +* Send messages to Azure IoT Hub +* Monitor device-to-cloud messages -Fixed issue #. +## Issues +Submit the [issues](https://github.com/formulahendry/vscode-azure-iot-toolkit/issues) if you find any bug or have any suggestion. -### 1.1.0 - -Added features X, Y, and Z. - ------------------------------------------------------------------------------------------------------------ - -## Working with Markdown - -**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: - -* Split the editor (`Cmd+\` on OSX or `Ctrl+\` on Windows and Linux) -* Toggle preview (`Shift+CMD+V` on OSX or `Shift+Ctrl+V` on Windows and Linux) -* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (OSX) to see a list of Markdown snippets - -### For more information - -* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) -* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) - -**Enjoy!** \ No newline at end of file +## Contribution +Fork the [repo](https://github.com/formulahendry/vscode-azure-iot-toolkit) and submit pull requests. \ No newline at end of file diff --git a/images/logo.png b/images/logo.png new file mode 100644 index 0000000..f490af8 Binary files /dev/null and b/images/logo.png differ diff --git a/images/monitor.gif b/images/monitor.gif new file mode 100644 index 0000000..4700d42 Binary files /dev/null and b/images/monitor.gif differ diff --git a/images/send.gif b/images/send.gif new file mode 100644 index 0000000..50bcde4 Binary files /dev/null and b/images/send.gif differ diff --git a/package.json b/package.json index 54558f8..108363e 100644 --- a/package.json +++ b/package.json @@ -4,12 +4,29 @@ "description": "Send messages to Azure IoT Hub, monitor device-to-cloud messages", "version": "0.0.1", "publisher": "formulahendry", + "icon": "images/logo.png", "engines": { "vscode": "^1.0.0" }, "categories": [ "Other" ], + "keywords": [ + "azure", + "iot", + "device", + "manage", + "cloud" + ], + "bugs": { + "url": "https://github.com/formulahendry/vscode-azure-iot-toolkit/issues", + "email": "formulahendry@gmail.com" + }, + "homepage": "https://github.com/formulahendry/vscode-azure-iot-toolkit/blob/master/README.md", + "repository": { + "type": "git", + "url": "https://github.com/formulahendry/vscode-azure-iot-toolkit.git" + }, "activationEvents": [ "onCommand:azure-iot-explorer.sendD2CMessage", "onCommand:azure-iot-explorer.startMonitoringMessage" @@ -102,4 +119,4 @@ "azure-iot-device": "^1.0.16", "azure-iot-device-http": "^1.0.16" } -} +} \ No newline at end of file diff --git a/src/azureIoTExplorer.ts b/src/azureIoTExplorer.ts index 8a14019..2c69c91 100644 --- a/src/azureIoTExplorer.ts +++ b/src/azureIoTExplorer.ts @@ -8,7 +8,7 @@ export class AzureIoTExplorer { constructor() { - let outputChannel = vscode.window.createOutputChannel('Azure IoT Explorer'); + let outputChannel = vscode.window.createOutputChannel('Azure IoT Toolkit'); let appInsightsClient = new AppInsightsClient(); this._messageExplorer = new MessageExplorer(outputChannel, appInsightsClient); }