You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by cwanda <gi...@git.apache.org> on 2017/03/31 18:53:34 UTC
[GitHub] incubator-mynewt-site pull request #167: Doc Updates for 1.0
GitHub user cwanda opened a pull request:
https://github.com/apache/incubator-mynewt-site/pull/167
Doc Updates for 1.0
1) Updated Check stats on a BLE device tutorial
- Removed versions and updated paths.
- Rename BLE Device to NRF52 Board
- Added build step for myble target
- Used new b scan parameters
2) Add load bootloader section to BLE HCI Tutorial
3) Use "main" task instead of "default" task in Add Console and Shell to Blinky tutorial.
4) Remove what the cputime module might be used for
5) Updated Console doc:
- Added description for minimal package
- Added newline parameter to console_read function
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/cwanda/incubator-mynewt-site updates_1.0
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-mynewt-site/pull/167.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #167
----
commit 4b222139d41fdb4f30f75e0268e2d19cc62f681d
Author: cwanda <wa...@happycity.com>
Date: 2017-03-31T18:35:19Z
1) Updated Check stats on a BLE device tutorial
- Removed versions and updated paths.
- Rename BLE Device to NRF52 Board
- Added build step for myble target
- Used new b scan parameters
2) Add load bootloader section to BLE HCI Tutorial
3) Use "main" task instead of "default" task in Add Console and Shell to Blinky tutorial.
4) Remove what the cputime module might be used for
5) Updated Console doc:
- Added description for minimal package
- Added newline parameter to console_read function
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-mynewt-site issue #167: Doc Updates for 1.0
Posted by aditihilbert <gi...@git.apache.org>.
Github user aditihilbert commented on the issue:
https://github.com/apache/incubator-mynewt-site/pull/167
Not sure why it "closed" it instead of "merging". But I merged all the changes.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-mynewt-site pull request #167: Doc Updates for 1.0
Posted by aditihilbert <gi...@git.apache.org>.
Github user aditihilbert commented on a diff in the pull request:
https://github.com/apache/incubator-mynewt-site/pull/167#discussion_r110482118
--- Diff: docs/os/tutorials/project-slinky.md ---
@@ -1,142 +1,36 @@
-## Project Sim Slinky
+## Project Slinky
+The goal of the project is to use a sample application called "Slinky" included in the Mynewt repository to enable remote communications with a device running the Mynewt OS. The protocol for remote communications is called newt manager (newtmgr).
-<br>
-
-The goal of the project is to use a sample app called "Slinky" included in the Mynewt repository to enable remote communications with a device running the Mynewt OS. The protocol for remote communications is called newt manager (newtmgr). In this tutorial we will create a target for a simulated device and define it with the sample app "Slinky".
+If you have an existing project using a target that does not use the Slinky application and you wish to add newtmgr functionality to it, check out the tutorial titled [Enable newtmgr in any app](add_newtmgr.md).
-If you have an existing project using a target that does not use the Slinky app and you wish to add newtmgt functonality to it, check out the tutorial titled [Enable newtmgr in any app](add_newtmgr.md).
+###Available Tutorials
+Tutorials are available for the following boards:
+* [Slinky on a simulated device](/os/tutorials/project-sim-slinky).
+* [Slinky on a nRF52](/os/tutorials/project-nrf52-slinky).
+* [Slinky on an Olimex](/os/tutorials/project-stm32-slinky).
<br>
### Prerequisites
-Ensure that you have met the following prerequisites before continuing with this tutorial:
+Ensure that you meet the following prerequisites before continuing with this tutorial:
* Have Internet connectivity to fetch remote Mynewt components.
-* Have a computer to build a Mynewt application.
+* Have a computer to build a Mynewt application and connect to the board over USB.
+* Have a Micro-USB cable to connect the board and the computer.
+* Have a [serial port setup](/os/get_started/serial_access.md).
* Install the newt tool and the toolchains (See [Basic Setup](/os/get_started/get_started.md)).
* Install the [newtmgr tool](../../newtmgr/installing/).
+* Create a project space (directory structure) and populated it with the core code repository (apache-mynewt-core) or kn
+ow how to as explained in [Creating Your First Project](/os/get_started/project_create).
* Read the Mynewt OS [Concepts](/os/get_started/vocabulary.md) section.
--- End diff --
will move this up
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-mynewt-site pull request #167: Doc Updates for 1.0
Posted by aditihilbert <gi...@git.apache.org>.
Github user aditihilbert commented on a diff in the pull request:
https://github.com/apache/incubator-mynewt-site/pull/167#discussion_r110480028
--- Diff: docs/os/tutorials/blinky.md ---
@@ -0,0 +1,47 @@
+## Blinky, your "Hello World!" on a Target Board
+The set of Blinky tutorials show you how to create, build, and run a "Hello World" application that blinks a LED on the various target boards that Mynewt supports. The tutorials use the same Blinky application from the [Creating Your First Project](/os/get_started/project_create) tutorial.
+
+### Objective
+
+Learn how to use packages from a default application repository of Mynewt to build your first *Hello World* application (Blinky) on a target board. Once built using the *newt* tool, this application will blink a LED light on the target board.
+
+###Available Tutorials
+Tutorials are available for the following boards:
+
+* [Blinky on an Arduino Zero](/os/tutorials/arduino_zero.md)
+* [Blinky on an Arduino Primo](/os/tutorials/blinky_primo.md)
+* [Blinky on an Olimex](/os/tutorials/olimex.md)
+* [Blinky on a nRF52](/os/tutorials/nRF52.md)
+* [Blinky on a RedBear Nano 2](/os/tutorials/rbnano2.md)
+
+We also have a tutorial that shows you how to add [Console and Shell to the Blinky Application](/os/tutorials/blinky_console.md).
+<br>
+### Prerequisites
+Ensure that you meet the following prerequisites before continuing with one of the tutorials.
+
+* Have Internet connectivity to fetch remote Mynewt components.
+* Have a computer to build a Mynewt application and connect to the board over USB.
+* Have a Micro-USB cable to connect the board and the computer.
+* Install the Newt tool and toolchains (See [Basic Setup](/os/get_started/get_started.md)).
+* Install either the Jlink or OpenOCD debugger.
+* Create a project space (directory structure) and populate it with the core code repository (apache-mynewt-core) or know how to as explained in [Creating Your First Project](/os/get_started/project_create).
+* Read the Mynewt OS [Concepts](/os/get_started/vocabulary.md) section.
+<br>
+###Overview of Steps
+These are the general steps to create, load and run the Blinky application on your board:
+
+* Create a project.
+* Define the bootloader and Blinky application targets for the board.
+* Build the bootloader target.
+* Build the Blinky application target and create an application image.
+* Connect to the board.
+* Load to bootloader onto the board.
+* Load to Blinky application image onto the board.
--- End diff --
will change "to" to "the" before merge
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-mynewt-site pull request #167: Doc Updates for 1.0
Posted by aditihilbert <gi...@git.apache.org>.
Github user aditihilbert commented on a diff in the pull request:
https://github.com/apache/incubator-mynewt-site/pull/167#discussion_r110480289
--- Diff: docs/os/tutorials/blinky.md ---
@@ -0,0 +1,47 @@
+## Blinky, your "Hello World!" on a Target Board
+The set of Blinky tutorials show you how to create, build, and run a "Hello World" application that blinks a LED on the various target boards that Mynewt supports. The tutorials use the same Blinky application from the [Creating Your First Project](/os/get_started/project_create) tutorial.
+
+### Objective
+
+Learn how to use packages from a default application repository of Mynewt to build your first *Hello World* application (Blinky) on a target board. Once built using the *newt* tool, this application will blink a LED light on the target board.
+
+###Available Tutorials
+Tutorials are available for the following boards:
+
+* [Blinky on an Arduino Zero](/os/tutorials/arduino_zero.md)
+* [Blinky on an Arduino Primo](/os/tutorials/blinky_primo.md)
+* [Blinky on an Olimex](/os/tutorials/olimex.md)
+* [Blinky on a nRF52](/os/tutorials/nRF52.md)
+* [Blinky on a RedBear Nano 2](/os/tutorials/rbnano2.md)
+
+We also have a tutorial that shows you how to add [Console and Shell to the Blinky Application](/os/tutorials/blinky_console.md).
+<br>
+### Prerequisites
+Ensure that you meet the following prerequisites before continuing with one of the tutorials.
+
+* Have Internet connectivity to fetch remote Mynewt components.
+* Have a computer to build a Mynewt application and connect to the board over USB.
+* Have a Micro-USB cable to connect the board and the computer.
+* Install the Newt tool and toolchains (See [Basic Setup](/os/get_started/get_started.md)).
+* Install either the Jlink or OpenOCD debugger.
+* Create a project space (directory structure) and populate it with the core code repository (apache-mynewt-core) or know how to as explained in [Creating Your First Project](/os/get_started/project_create).
+* Read the Mynewt OS [Concepts](/os/get_started/vocabulary.md) section.
+<br>
+###Overview of Steps
+These are the general steps to create, load and run the Blinky application on your board:
+
+* Create a project.
+* Define the bootloader and Blinky application targets for the board.
+* Build the bootloader target.
+* Build the Blinky application target and create an application image.
+* Connect to the board.
+* Load to bootloader onto the board.
+* Load to Blinky application image onto the board.
+* See the LED on your board blink.
+
+<br>
+
+After you try the Blinky application on your boards, checkout out other tutorials to enable additional functionality such as [remote comms](project-slinky.md) on the current board.
+
--- End diff --
will add check stat project too
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-mynewt-site issue #167: Doc Updates for 1.0
Posted by cwanda <gi...@git.apache.org>.
Github user cwanda commented on the issue:
https://github.com/apache/incubator-mynewt-site/pull/167
Hi Fabio,
These are ready for review.
Thanks,
Wanda
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-mynewt-site pull request #167: Doc Updates for 1.0
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/incubator-mynewt-site/pull/167
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-mynewt-site pull request #167: Doc Updates for 1.0
Posted by aditihilbert <gi...@git.apache.org>.
Github user aditihilbert commented on a diff in the pull request:
https://github.com/apache/incubator-mynewt-site/pull/167#discussion_r110482369
--- Diff: mkdocs.yml ---
@@ -47,10 +48,11 @@ pages:
- 'Enable Wi-Fi on Arduino MKR1000': 'os/tutorials/wi-fi_on_arduino.md'
- 'Write a Test Suite for a Package': 'os/tutorials/unit_test.md'
- 'Events and Event Queues': 'os/tutorials/event_queue.md'
- - 'Project Slinky for remote comms':
- - 'Slinky on sim device': 'os/tutorials/project-slinky.md'
- - 'Slinky on Nordic nRF52 board': 'os/tutorials/project-target-slinky.md'
- - 'Slinky on STM32 board': 'os/tutorials/project-stm32-slinky.md'
+ - 'Project Slinky for Remote Comms':
+ - toc: 'os/tutorials/project-slinky.md'
+ - 'Slinky on sim device': 'os/tutorials/project-sim-slinky.md'
+ - 'Slinky on Nordic nRF52': 'os/tutorials/project-nrf52-slinky.md'
+ - 'Slinky on Olimex': 'os/tutorials/project-stm32-slinky.md'
--- End diff --
I will reorder these a little: move up Slinky and Checks stats in the list so people can go down the list in increasing order of complexity/new concepts.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-mynewt-site issue #167: Doc Updates for 1.0
Posted by utzig <gi...@git.apache.org>.
Github user utzig commented on the issue:
https://github.com/apache/incubator-mynewt-site/pull/167
Let us know when this is OK for review/merge.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---