Merge remote-tracking branch 'origin/master' into pre-release

This commit is contained in:
Liya Du 2020-01-09 15:47:26 +08:00
Родитель b915dbb08a 4984dc776d
Коммит bda196f033
26 изменённых файлов: 840 добавлений и 645 удалений

22
.github/workflows/close-resolved-issues.yml поставляемый Normal file
Просмотреть файл

@ -0,0 +1,22 @@
name: Close resolved issues
on:
schedule:
- cron: "0 * * * *"
jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: blackchoey/stale@releases/v1.2
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-message: 'This issue has been resolved and it will be closed if no further activity occurs within 3 days. Thank you for your contributions.'
stale-issue-label: 'pending close'
days-before-stale: 7
only-labels: 'resolved'
last-updated-user-type: 'collaborator'
days-before-close: 3
operations-per-run: 150

21
.github/workflows/need-attention-issues.yml поставляемый Normal file
Просмотреть файл

@ -0,0 +1,21 @@
name: Pickup issues that needs attention
on:
schedule:
- cron: "0 * * * *"
jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: blackchoey/stale@releases/v1.2
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-message: 'This issue has no recent activities, please take a look and provide updates for it.'
stale-issue-label: 'need attention'
days-before-stale: 3
last-updated-user-type: 'non-collaborator'
days-before-close: 999
operations-per-run: 150

22
.github/workflows/stale-issues.yml поставляемый Normal file
Просмотреть файл

@ -0,0 +1,22 @@
name: Mark stale issues and close them
on:
schedule:
- cron: "0 * * * *"
jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: blackchoey/stale@releases/v1.2
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-message: 'This issue has been automatically marked as stale because it has no recent activities. It will be closed if no further activity occurs within 3 days. Thank you for your contributions.'
stale-issue-label: 'stale'
days-before-stale: 7
only-labels: 'need more info'
last-updated-user-type: 'collaborator'
days-before-close: 3
operations-per-run: 150

Просмотреть файл

@ -2,14 +2,31 @@
**The IoT DevKit Tooling team wants to hear from you!**
- [Contribute documentation](#contribute-documentation)
- [Ask a question](#ask-a-question)
- [File a bug](#file-a-bug)
- [Contribute documentation](#contribute-documentation)
- [Contribute code](#contribute-code)
- [Code of Conduct](#Open-Source-Code-of-Conduct)
Note we have a code of conduct, please follow it in all your interactions with the project.
# Contribute documentation
## Setup
Fork this repo and use [GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages) to deploy.
## Testing it Locally
Also you can run and test it locally. Here is a quick write-up of the necessary steps:
1. Download and install Ruby installer for Windows (2.4.3): https://rubyinstaller.org/downloads/
2. Launch command, install Jekyll and Bundler: 'gem install jekyll bundler'
3. Git clone the doc repo: 'git clone https://github.com/Microsoft/azure-iot-developer-kit.git'
4. Go into the doc repo cloned and update the submodules: 'git submodule update --init --recursive'
5. Go into the /docs folder within the repo, and install the necessary bundles for Jekyll: 'bundle install'
6. Now in the /docs folder, start the local server: 'bundle exec jekyll serve'
7. Open 'http://localhost:4000' in browser you should see the local docs
8. Update any markdown or update the image fill trigger the auto rebuild, you should reload the browser to see the changes.
# Ask a question
Our team monitors the [chat room](https://gitter.im/Microsoft/azure-iot-developer-kit). It really is the best place to ask.
@ -25,8 +42,8 @@ That is definitely something we want to hear about. Please open an issue on gith
*Our IoT DevKit SDK are open-source and we do accept pull-requests if you feel like taking a stab at fixing the bug and maybe adding your name to our commit history :) Please mention any relevant issue number in the pull request description.* Please see [Contribute code](#contribute-code) below.
# Contribute code or documentation
We require pull-requests for code and documentation to be submitted against the `master` branch in order to review and run it in our gated build system.
# Contribute code
We require pull-requests for code to be submitted against the `master` branch in order to review and run it in our gated build system.
## Build and Run From Source
@ -116,5 +133,4 @@ _This code of conduct is based on the [template][template] established by the [T
[template]: http://todogroup.org/opencodeofconduct
[group]: http://todogroup.org/
[version]: http://contributor-covenant.org/version/1/4/
[git]: https://git-scm.com/
[git]: https://git-scm.com/

Просмотреть файл

@ -1,11 +1,13 @@
source "https://rubygems.org"
gem 'github-pages', '192', group: :jekyll_plugins
gem 'github-pages', '198', group: :jekyll_plugins
gem "wdm", "~> 0.1.0" if Gem.win_platform?
gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw]
gem "nokogiri", "~> 1.10.4 "
# If you have any plugins, put them here!
group :jekyll_plugins do
gem "jekyll-autoprefixer"

Просмотреть файл

@ -1,14 +1,14 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (4.2.10)
activesupport (4.2.11.1)
i18n (~> 0.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
addressable (2.5.2)
public_suffix (>= 2.0.2, < 4.0)
autoprefixer-rails (6.3.7)
addressable (2.7.0)
public_suffix (>= 2.0.2, < 5.0)
autoprefixer-rails (9.6.1.1)
execjs
coffee-script (2.4.1)
coffee-script-source
@ -17,40 +17,38 @@ GEM
colorator (1.1.0)
commonmarker (0.17.13)
ruby-enum (~> 0.5)
concurrent-ruby (1.1.3)
dnsruby (1.61.2)
concurrent-ruby (1.1.5)
dnsruby (1.61.3)
addressable (~> 2.5)
em-websocket (0.5.1)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
ethon (0.11.0)
ethon (0.12.0)
ffi (>= 1.3.0)
eventmachine (1.2.7)
eventmachine (1.2.7-x64-mingw32)
execjs (2.7.0)
faraday (0.15.3)
faraday (0.15.4)
multipart-post (>= 1.2, < 3)
ffi (1.9.25)
ffi (1.9.25-x64-mingw32)
ffi (1.11.1-x64-mingw32)
forwardable-extended (2.6.0)
gemoji (3.0.0)
github-pages (192)
activesupport (= 4.2.10)
github-pages-health-check (= 1.8.1)
jekyll (= 3.7.4)
gemoji (3.0.1)
github-pages (198)
activesupport (= 4.2.11.1)
github-pages-health-check (= 1.16.1)
jekyll (= 3.8.5)
jekyll-avatar (= 0.6.0)
jekyll-coffeescript (= 1.1.1)
jekyll-commonmark-ghpages (= 0.1.5)
jekyll-default-layout (= 0.1.4)
jekyll-feed (= 0.10.0)
jekyll-feed (= 0.11.0)
jekyll-gist (= 1.5.0)
jekyll-github-metadata (= 2.9.4)
jekyll-github-metadata (= 2.12.1)
jekyll-mentions (= 1.4.1)
jekyll-optional-front-matter (= 0.3.0)
jekyll-paginate (= 1.1.0)
jekyll-readme-index (= 0.2.0)
jekyll-redirect-from (= 0.14.0)
jekyll-relative-links (= 0.5.3)
jekyll-relative-links (= 0.6.0)
jekyll-remote-theme (= 0.3.1)
jekyll-sass-converter (= 1.5.2)
jekyll-seo-tag (= 2.5.0)
@ -70,7 +68,7 @@ GEM
jekyll-theme-tactile (= 0.1.1)
jekyll-theme-time-machine (= 0.1.1)
jekyll-titles-from-headings (= 0.5.1)
jemoji (= 0.10.1)
jemoji (= 0.10.2)
kramdown (= 1.17.0)
liquid (= 4.0.0)
listen (= 3.1.5)
@ -79,19 +77,19 @@ GEM
nokogiri (>= 1.8.5, < 2.0)
rouge (= 2.2.1)
terminal-table (~> 1.4)
github-pages-health-check (1.8.1)
github-pages-health-check (1.16.1)
addressable (~> 2.3)
dnsruby (~> 1.60)
octokit (~> 4.0)
public_suffix (~> 2.0)
public_suffix (~> 3.0)
typhoeus (~> 1.3)
html-pipeline (2.9.0)
html-pipeline (2.12.0)
activesupport (>= 2)
nokogiri (>= 1.8.5)
nokogiri (>= 1.4)
http_parser.rb (0.6.0)
i18n (0.9.5)
concurrent-ruby (~> 1.0)
jekyll (3.7.4)
jekyll (3.8.5)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
@ -104,28 +102,28 @@ GEM
pathutil (~> 0.9)
rouge (>= 1.7, < 4)
safe_yaml (~> 1.0)
jekyll-autoprefixer (1.0.1)
autoprefixer-rails (~> 6.3.6)
jekyll-autoprefixer (1.0.2)
autoprefixer-rails (~> 9.3)
jekyll-avatar (0.6.0)
jekyll (~> 3.0)
jekyll-coffeescript (1.1.1)
coffee-script (~> 2.2)
coffee-script-source (~> 1.11.1)
jekyll-commonmark (1.2.0)
jekyll-commonmark (1.3.1)
commonmarker (~> 0.14)
jekyll (>= 3.0, < 4.0)
jekyll (>= 3.7, < 5.0)
jekyll-commonmark-ghpages (0.1.5)
commonmarker (~> 0.17.6)
jekyll-commonmark (~> 1)
rouge (~> 2)
jekyll-default-layout (0.1.4)
jekyll (~> 3.0)
jekyll-feed (0.10.0)
jekyll-feed (0.11.0)
jekyll (~> 3.3)
jekyll-gist (1.5.0)
octokit (~> 4.2)
jekyll-github-metadata (2.9.4)
jekyll (~> 3.1)
jekyll-github-metadata (2.12.1)
jekyll (~> 3.4)
octokit (~> 4.0, != 4.4.0)
jekyll-mentions (1.4.1)
html-pipeline (~> 2.3)
@ -137,7 +135,7 @@ GEM
jekyll (~> 3.0)
jekyll-redirect-from (0.14.0)
jekyll (~> 3.3)
jekyll-relative-links (0.5.3)
jekyll-relative-links (0.6.0)
jekyll (~> 3.3)
jekyll-remote-theme (0.3.1)
jekyll (~> 3.5)
@ -191,9 +189,9 @@ GEM
jekyll-seo-tag (~> 2.0)
jekyll-titles-from-headings (0.5.1)
jekyll (~> 3.3)
jekyll-watch (2.1.2)
jekyll-watch (2.2.1)
listen (~> 3.0)
jemoji (0.10.1)
jemoji (0.10.2)
gemoji (~> 3.0)
html-pipeline (~> 2.2)
jekyll (~> 3.0)
@ -204,39 +202,37 @@ GEM
rb-inotify (~> 0.9, >= 0.9.7)
ruby_dep (~> 1.2)
mercenary (0.3.6)
mini_portile2 (2.3.0)
mini_portile2 (2.4.0)
minima (2.5.0)
jekyll (~> 3.5)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
minitest (5.11.3)
multipart-post (2.0.0)
nokogiri (1.8.5)
mini_portile2 (~> 2.3.0)
nokogiri (1.8.5-x64-mingw32)
mini_portile2 (~> 2.3.0)
octokit (4.13.0)
multipart-post (2.1.1)
nokogiri (1.10.4-x64-mingw32)
mini_portile2 (~> 2.4.0)
octokit (4.14.0)
sawyer (~> 0.8.0, >= 0.5.3)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (2.0.5)
public_suffix (3.1.1)
rb-fsevent (0.10.3)
rb-inotify (0.9.10)
ffi (>= 0.5.0, < 2)
rb-inotify (0.10.0)
ffi (~> 1.0)
rouge (2.2.1)
ruby-enum (0.7.2)
i18n
ruby_dep (1.5.0)
rubyzip (1.2.2)
safe_yaml (1.0.4)
sass (3.7.2)
rubyzip (1.2.4)
safe_yaml (1.0.5)
sass (3.7.4)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
sawyer (0.8.1)
addressable (>= 2.3.5, < 2.6)
faraday (~> 0.8, < 1.0)
sawyer (0.8.2)
addressable (>= 2.3.5)
faraday (> 0.8, < 2.0)
terminal-table (1.8.0)
unicode-display_width (~> 1.1, >= 1.1.1)
thread_safe (0.3.6)
@ -244,23 +240,23 @@ GEM
ethon (>= 0.9.0)
tzinfo (1.2.5)
thread_safe (~> 0.1)
tzinfo-data (1.2018.7)
tzinfo-data (1.2019.3)
tzinfo (>= 1.0.0)
unicode-display_width (1.4.0)
unicode-display_width (1.6.0)
wdm (0.1.1)
PLATFORMS
ruby
x64-mingw32
DEPENDENCIES
github-pages (= 192)
github-pages (= 198)
jekyll-autoprefixer
jekyll-paginate
jekyll-redirect-from
jemoji
nokogiri (~> 1.10.4)
tzinfo-data
wdm (~> 0.1.0)
BUNDLED WITH
1.17.1
1.17.3

Просмотреть файл

@ -27,7 +27,7 @@ icons:
target: https://azure.microsoft.com/en-us/services/cognitive-services/
title: Cognitive Services
difficulty: HARD
difficulty: ARCHIVED
last_modified_at: 2019-4-12
---

Просмотреть файл

Просмотреть файл

@ -8,7 +8,7 @@ main:
url: /docs/projects/
- title: "Blog"
url: https://devblogs.microsoft.com/iotdev/
- title: "v1.6.2"
- title: "v1.6.5"
url: /versions/
class: "masthead-circle"
@ -27,6 +27,8 @@ docs:
url: /docs/understand-security-chip/
- title: "Disable data collection"
url: /docs/disable-data-collection/
- title: "Serial communications"
url: /docs/serial-communications/
- title: "FAQ"
url: /docs/faq/
- title: API Reference

Просмотреть файл

@ -39,7 +39,7 @@ The status between enabling and disabling the security channel.
![STSAFE status]({{"/assets/images/how-to/stsafe/stsafe-status.png" | absolute_url }})
The difference of the data commuinication between IoT DevKit and the security chip (EEPROM).
The difference of the data communication between IoT DevKit and the security chip (EEPROM).
![STSAFE communication with IoT DevKit]({{"/assets/images/how-to/stsafe/communication.png" | absolute_url }})

Просмотреть файл

@ -0,0 +1,75 @@
---
title: "Serial communications"
permalink: /docs/serial-communications/
excerpt: "Communication with other devices over the built in serial ports."
variable:
- platform: windows
name: Windows
- platform: macos
name: macOS
last_modified_at: 2019-09-10
---
{% include toc icon="columns" %}
## Overview
The MXChip IoT DevKit has two UART serial ports. One is connected to the USB port and allows you to send serial data over a USB cable, such as debugging information. The other is available from Pins 1 and 2 on the finger connector and allows you to connect the device to other modules that send data over serial.
## Sending data over the USB serial port
The USB serial port is available using the `Serial` global variable, and this uses the `UART_0` serial port. The API for this is identical to the standard Arduino `Serial` API, which you can read about in the [Arduino Serial communication docs](https://www.arduino.cc/reference/en/language/functions/communication/serial/).
```c
// Open the serial port at a speed of 115200 baud
Serial.begin(115200);
// Send a message over the serial connection
Serial.write("Hello");
```
You can monitor data sent over this serial connection using the VS Code Serial Monitor, available from the command palette by selecting *Arduino: Open Serial Monitor*. The board will send logging information over this port in addition to the data you send.
![The serial monitor showing logging messages and hello]({{"/assets/images/how-to/serial/serialmonitor.png" | absolute_url }})
## Sending data over the finger connector serial port
The second UART serial port is available via the finger connector on the large pins 1 and 2.
![The MXChip finger connector with pin 1 marked as TX and pin 2 marked as RX]({{"/assets/images/how-to/serial/board_annotated_pins.png" | absolute_url }})
| Pin | Usage |
| --- | ------------- |
| 1 | TX - Transmit |
| 2 | RX - Receive |
Pin 1 is the transmit (TX) pin, and is used to send serial data to an external module. This pin should connect to the **RX** pin on the external module.
Pin 2 is the receive (RX) pin, and is used to receive serial data from an external module. This pin should connect to the **TX** pin on the external module.
> NOTE: The TX pin on the MXChip IoT DevKit needs to connect to the RX pin on an external module, and vice versa. The signal transmitted needs to go to a receiving pin.
Once the device is connected, you will need to declare a new `UARTClass` variable pointing to the second serial port, `UART_1`.
```c
UARTClass Serial1(UART_1);
```
This has the same type as the `Serial` global variable, and uses the same serial API.
```c
// Open the serial port at a speed of 9600 baud
Serial.begin(9600);
// Read a byte from the second serial port
int byte = Serial1.read();
// Send the byte to the USB serial port for debugging
Serial.write(byte);
```
## Problems and feedback
If you encounter problems, you can find [FAQs]({{"/docs/faq/" | absolute_url }}) if you encounter problems or reach out to us from our [Gitter channel](https://gitter.im/Microsoft/azure-iot-developer-kit){:target="_blank"}.
{% include feedback.html tutorial="serial-communications" %}

Просмотреть файл

@ -55,7 +55,7 @@ projects: "0, 3, 10"
</ul>
</span>
<a href="https://devblogs.microsoft.com/iotdev/" class="item">Blog</a>
<a href="{{ site.baseurl }}/versions/" class="version">V1.6.2</a>
<a href="{{ site.baseurl }}/versions/" class="version">V1.6.5</a>
</span>
</div>
@ -64,7 +64,7 @@ projects: "0, 3, 10"
<div class="content">
<h1>A<span id="typing">n all-in-one</span> IoT kit</h1>
<h1>built for the cloud</h1>
<div class="description">All the seneors and parts you love, no soldering needed. Welcome to cloud IoT
<div class="description">All the sensors and parts you love, no soldering needed. Welcome to cloud IoT
development.</div>
<div class="button-group">
<button class="btn primary" onclick="window.open('{{ btn_primary_url }}')"><span>Get a Kit</span></button>

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -2,7 +2,7 @@
title: "Firmware OTA"
permalink: /docs/projects/devkit-ota/
redirect_to:
- https://github.com/Microsoft/vscode-iot-workbench/blob/master/docs/iot-devkit/devkit-ota.md
- https://docs.microsoft.com/en-us/samples/azure-samples/mxchip-iot-devkit-firmware-ota/sample/
excerpt: "Update IoT DevKit firmware OTA (Over-the-Air) through Azure IoT Hub Automatic Device Management."
header:
overlay_image: /assets/images/projects-ota-firmware-updateg.jpg

Просмотреть файл

@ -1,6 +1,6 @@
---
title: "Connect to Microsoft IoT Central"
link: "https://docs.microsoft.com/microsoft-iot-central/howto-connect-devkit"
link: "https://docs.microsoft.com/azure/iot-central/core/howto-connect-devkit"
excerpt: "Learn as a device developer, to connect a DevKit to your Microsoft IoT Central application. All within 5 minutes."
header:
image: /assets/images/projects-iot-central.jpg

Просмотреть файл

@ -2,7 +2,7 @@
title: "DevKit State"
permalink: /docs/projects/devkit-state/
redirect_to:
- https://github.com/Microsoft/vscode-iot-workbench/blob/master/docs/iot-devkit/devkit-state.md
- https://docs.microsoft.com/en-us/samples/azure-samples/mxchip-iot-devkit-state/sample/
excerpt: "Monitor DevKit states and control the user LED with Azure IoT Hub device twins."
header:
overlay_image: /assets/images/projects-devKit-state-th.jpg
@ -14,4 +14,4 @@ icons:
title: IoT Hub
difficulty: EASY
last_modified_at: 2019-04-26
---
---

Просмотреть файл

@ -2,7 +2,7 @@
title: "DevKit Translator"
permalink: /docs/projects/devkit-translator/
redirect_to:
- https://docs.microsoft.com/azure/iot-hub/iot-hub-arduino-iot-devkit-az3166-translator
- https://docs.microsoft.com/en-us/samples/azure-samples/mxchip-iot-devkit-translator/sample/
excerpt: "Turn IoT DevKit as a translator by using Bing Speech Translator service."
header:
overlay_image: /assets/images/projects-devkit-translator.jpg

Просмотреть файл

@ -2,7 +2,7 @@
title: "MQTT Client"
permalink: /docs/projects/mqtt-helloworld/
redirect_to:
- https://github.com/Microsoft/vscode-iot-workbench/blob/master/docs/iot-devkit/devkit-mqtt-client.md
- https://docs.microsoft.com/en-us/samples/azure-samples/mxchip-iot-devkit-mqtt-client/sample/
excerpt: "Use IoT DevKit as a client to send messages to MQTT server."
header:
overlay_image: /assets/images/projects-mqtt-helloworld.jpg

Просмотреть файл

@ -2,7 +2,7 @@
title: "Shake, Shake for a Tweet"
permalink: /docs/projects/shake-shake/
redirect_to:
- https://github.com/Microsoft/vscode-iot-workbench/blob/master/docs/iot-devkit/devkit-shakeshake.md
- https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-arduino-iot-devkit-az3166-translator
excerpt: "Use the motion sensor to detect shaking and find a random tweet with a #hashtag."
header:
overlay_image: /assets/images/projects-shake-shake.jpg
@ -34,7 +34,7 @@ icons:
- url: /assets/images/icon-azure-functions.svg
target: https://azure.microsoft.com/en-us/services/functions/
title: Azure Functions
difficulty: MEDIUM
difficulty: ARCHIVED
variable:
- platform: windows
name: Windows

Просмотреть файл

@ -2,7 +2,7 @@
title: "Door Monitor"
permalink: /docs/projects/door-monitor/
redirect_to:
- https://github.com/Microsoft/vscode-iot-workbench/blob/master/docs/iot-devkit/devkit_door_monitor.md
- https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-arduino-iot-devkit-az3166-door-monitor
excerpt: "Use magnetic sensor to detect the change of magnetic field, and send notifications."
header:
overlay_image: /assets/images/projects-door-monitor.jpg
@ -25,7 +25,7 @@ icons:
- url: /assets/images/icon-sendgrid.svg
target: https://sendgrid.com/partners/azure/
title: SendGrid
difficulty: MEDIUM
difficulty: ARCHIVED
variable:
- platform: windows
name: Windows

Просмотреть файл

@ -16,6 +16,6 @@ icons:
- url: /assets/images/icon-cognitive-services.svg
target: https://azure.microsoft.com/services/cognitive-services/?v=17.29
title: Cognitive Services
difficulty: MEDIUM
difficulty: ARCHIVED
last_modified_at: 2019-04-26
---

Двоичные данные
docs/assets/images/how-to/serial/board_annotated_pins.png Normal file

Двоичный файл не отображается.

После

Ширина:  |  Высота:  |  Размер: 28 KiB

Двоичные данные
docs/assets/images/how-to/serial/serialmonitor.png Normal file

Двоичный файл не отображается.

После

Ширина:  |  Высота:  |  Размер: 68 KiB

2
docs/assets/js/main.min.js поставляемый

Различия файлов скрыты, потому что одна или несколько строк слишком длинны

Просмотреть файл

@ -297,6 +297,8 @@
$(this).css('background', '#f98f40');
} else if (difficulty == 'hard') {
$(this).css('background', '#f05a2d');
} else if (difficulty == 'archived') {
$(this).css('background', '#696969');
}
});
}

Просмотреть файл

@ -1 +1 @@
1.6.2
1.6.5