Skip to content
Permalink
Browse files

doc: fix misspellings in documentation

Fix misspellings and doc issues missed during regular reviews (including
some files without a trailing newline)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
  • Loading branch information...
dbkinder authored and nashif committed Jun 18, 2019
1 parent 2aebc98 commit 6b2cd292235014f9ca9384d163900865519ef0d6
@@ -125,7 +125,7 @@ I2C
- I2C3_SCL : PB4

I2C3 goes to the P2 connector and can be used to attach external sensors.
It goes to 100kbit maximum.
It goes to 100Kbit maximum.

SPI
---
@@ -33,7 +33,7 @@ Hardware
- 16 KB SRAM
- On board sensors:

- Acclerometer: STMicro LIS3DH
- Accelerometer: STMicro LIS3DH
- Integrated Environmental sensor: Bosch BME680

- 2 User LEDs
@@ -136,11 +136,11 @@ externally connected SPI devices.
+-------------+------------------------------------------------------------------------------------------+
| Device | SERCOM4 |
+-------------+------------------------------------------------------------------------------------------+
| MOSI | PB30 (OUT, SPI mosi) |
| MOSI | PB30 (OUT, SPI MOSI) |
+-------------+------------------------------------------------------------------------------------------+
| MISO | PC19 (IN, SPI miso) |
| MISO | PC19 (IN, SPI MISO) |
+-------------+------------------------------------------------------------------------------------------+
| SCLK | PC18 (OUT, SPI sclk) |
| SCLK | PC18 (OUT, SPI SCLK) |
+-------------+------------------------------------------------------------------------------------------+
| CS | PB31 (OUT, GPIO output) |
+-------------+------------------------------------------------------------------------------------------+
@@ -163,7 +163,7 @@ Default Zephyr Peripheral Mapping:
System Clock
------------

B-L072Z-LRWAN1 Discovery board System Clock is at 32mhz.
B-L072Z-LRWAN1 Discovery board System Clock is at 32MHz.

Serial Port
-----------
@@ -129,7 +129,7 @@ Default Zephyr Peripheral Mapping:
System Clock
------------

Dragino LSN50 System Clock is at 32mhz,
Dragino LSN50 System Clock is at 32MHz,

Serial Port
-----------
@@ -19,7 +19,7 @@ Hardware
********

- MEC1701QC2SZ ARM Cortex-M4F Processor
- 480 KB Ram and 64 KB boot Rom
- 480 KB RAM and 64 KB boot ROM
- 2 Microchip BC-Link Interconnection bus
- Keyboard interface
- ADC & GPIO headers
@@ -37,7 +37,7 @@ Supported Features
- CPU:
+ Nordic nRF51822: ARM |reg| Cortex |trade| M0 32bit.
+ *Bluetooth Low Energy interface.*
+ 256KB Flash, 32KB Ram.
+ 256KB Flash, 32KB RAM.
+ UART(1), I2C(2), SPI(1), PWM(3), SWD, Timer 16bit(3).
+ 21 digital channels, 6 ADC 10bit channels.
+ 1 Led and 1 Button onboard.
@@ -137,7 +137,7 @@ By default, the board controller firmware will route the following:
+-----------------+----------------------------------+
| nRF9160 UART1 | VCOM2 |
+-----------------+----------------------------------+
| Leds 1-4 | physical LEDs |
| LEDs 1-4 | physical LEDs |
+-----------------+----------------------------------+
| Buttons 1-2 | physical buttons |
+-----------------+----------------------------------+
@@ -110,7 +110,7 @@ The STM32MP157 SoC provides the following hardware capabilities:
- HDMI-CEC interface
- MDIO Slave interface
- 3 × SDMMC up to 8-bit (SD / e•MMC™ / SDIO)
- 2 × CAN controllers supporting CAN FD protocol, TTCAN capiblity
- 2 × CAN controllers supporting CAN FD protocol, TTCAN capability
- 2 × USB 2.0 high-speed Host+ 1 × USB 2.0 full-speed OTG simultaneously
- 10/100M or Gigabit Ethernet GMAC (IEEE 1588v2 hardware, MII/RMII/GMII/RGMI)
- 8- to 14-bit camera interface up to 140 Mbyte/s
@@ -242,7 +242,7 @@ Debugging
You can debug an application using OpenOCD and GDB. The Solution proposed below
is based on the Linux STM32MP1 SDK OpenOCD and is available only for a Linux
environment. The firmware must first be loaded by the Cortex®-A7. Developer
then attachs the debugger to the running Zephyr using OpenOCD.
then attaches the debugger to the running Zephyr using OpenOCD.

Prerequisite
------------
@@ -29,7 +29,7 @@ The HiFive 1 Rev B uses Segger J-Link OB for flashing and debugging. To flash an
debug the board, you'll need to install the
`Segger J-Link Software and Documentation Pack
<https://www.segger.com/downloads/jlink#J-LinkSoftwareAndDocumentationPack>`_
and choose version V6.46a or later (Downloads for Windows, Linux, and MacOS are
and choose version V6.46a or later (Downloads for Windows, Linux, and macOS are
available).

With the Segger J-Link Software installed, you can flash the application as usual
@@ -84,7 +84,7 @@ Serial Port Support

Serial port I/O is supported in both polling and interrupt-driven modes.

Baud rates beyond 115.2kbps (up to 3.6864Mbps) are supported, with additional
Baud rates beyond 115.2Kbps (up to 3.6864Mbps) are supported, with additional
configuration. The UARTs are fed a master clock which is fed into a PLL which
in turn outputs the baud master clock. The PLL is controlled by a per-UART
32-bit register called ``PRV_CLOCK_PARAMS`` (aka the ``PCP``), the format of
@@ -114,14 +114,14 @@ stakeholders, to help recruit new members and it can be a helpful resource the
team and community can refer to throughout the project's development, to ensure
they are still executing according to plan.

As such, the roadmap should contain only strategic-level detailsmajor project
As such, the roadmap should contain only strategic-level details, major project
themes, epics, and goals.


Release Plans
==============

The release plan comes into play when the project roadmaps high-level strategy
The release plan comes into play when the project roadmap's high-level strategy
is translated into an actionable plan built on specific features, enhancements,
and fixes that need to go into a specific release or milestone.

@@ -198,7 +198,7 @@ application ``CMakeList.txt`` file.

set(ZEPHYR_BOARD_FLASH_RUNNER jlink)

If you use West (Zephyrs meta-tool) you can modify the default runner using
If you use West (Zephyr's meta-tool) you can modify the default runner using
the ``--runner`` (or ``-r``) option.

.. code-block:: console
@@ -169,7 +169,7 @@ Requirements

Modules to be included in the default manifest of the Zephyr project need to
provide functionality or features endorsed and approved by the project technical
steering committee and should follow the project licencing and
steering committee and should follow the project licensing and
:ref:`contribute_guidelines`.

A request for a new module should be initialized using an RFC issue in the
@@ -179,7 +179,7 @@ created by the project team and initialized with basic information that would
allow submitting code to the module project following the project contribution
guidelines.

All modules should be hosted in repositories under the Zephyr organisation. The
All modules should be hosted in repositories under the Zephyr organization. The
manifest should only point to repositories maintained under the Zephyr project.
If a module is maintained as a fork of another project on Github, the Zephyr module
related files and changes in relation to upstream need to be maintained in a
@@ -52,4 +52,4 @@ Sample Output
***** Hardware exception *****
Current thread ID = 0x20000400
Faulting instruction address = 0x80004a8
Fatal fault in thread 0x20000400! Aborting.
Fatal fault in thread 0x20000400! Aborting.
@@ -25,12 +25,13 @@ updatehub_manual.
Caveats
*******

* The Zephyr port of ``UpdateHub`` is configured to run on a :ref:`Freedom-K64F <frdm_k64f>`
MCU by default. The application should build and run for other platforms
with offer support internet connection. Some platforms need some modification.
Overlay files would be needed to support BLE 6lowpan, 802.15.4 or OpenThread
configurations as well as the understanding that most other connectivity
options would require an edge gateway of some sort (Border Router, etc).
* The Zephyr port of ``UpdateHub`` is configured to run on a
:ref:`Freedom-K64F <frdm_k64f>` MCU by default. The application should
build and run for other platforms with offer support internet
connection. Some platforms need some modification. Overlay files would
be needed to support BLE 6lowpan, 802.15.4 or OpenThread configurations
as well as the understanding that most other connectivity options would
require an edge gateway of some sort (Border Router, etc).

* The MCUboot bootloader is required for ``UpdateHub`` to function
properly. More information about the Device Firmware Upgrade subsystem and
@@ -67,18 +68,19 @@ Step 3: Start the updatehub Community Edition
By default, the updatehub application is set to start on the UpdateHub Cloud.
For more details on how to use the UpdateHub Cloud please refer to the
documentation on `updatehub.io`_.
The UpdateHub Cloud has the option to use CoAPS/DTLS or not. If the user want
to use the CoAPS/DTLS just need to add the ``overlay-dtls.conf`` at the build.
You must use the certificate available just for test example. For you create a new certificates
you can execute this following commands:
The UpdateHub Cloud has the option to use CoAPS/DTLS or not. If you want
to use the CoAPS/DTLS, simply add the ``overlay-dtls.conf`` before building.
You must only use the provided certificate for the test example.
Otherwise, you should create a new certificate using these commands:

.. code-block:: console

openssl genrsa -out privkey.pem 512

openssl req -new -x509 -key privkey.pem -out servercert.pem

The cert and private key that is to be embedded into certificates.h in your application, can be generated like this:
The cert and private key that will be embedded into ``certificates.h`` in
your application, can be generated like this:

.. code-block:: console

@@ -93,16 +95,18 @@ following Docker command:

.. code-block:: console

docker run -it -p 8080:8080 -p 5683:5683/udp --rm updatehub/updatehub-ce:latest
docker run -it -p 8080:8080 -p 5683:5683/udp --rm \
updatehub/updatehub-ce:latest

Using this server the user need create own ``overaly-prj.conf`` setting the option
:option:`CONFIG_UPDATEHUB_SERVER` with your local ip address and the option
:option:`CONFIG_UPDATEHUB_CE` with true. If the user will use polling mode on
UpdateHub need too set the option :option:`CONFIG_UPDATEHUB_POLL_INTERVAL` with the period of
your preference, remembering that the limit is between 0 minute until 43200 minutes(30 days).
This server does not use DTLS, so you must not add ``overlay-dtls.config``.
This sample uses IPv4 by default, but if you would like use IPv6 is possible too, need just
enable IPv6 and configure your IP address.
Using this server, create your own ``overlay-prj.conf``, setting the
option :option:`CONFIG_UPDATEHUB_SERVER` with your local IP address and
the option :option:`CONFIG_UPDATEHUB_CE` with true. If you're using the
polling mode on UpdateHub, you'll also need to set the option
:option:`CONFIG_UPDATEHUB_POLL_INTERVAL` with the polling period of your
preference, remembering that the limit is between 0 and 43200 minutes
(30 days). This server does not use DTLS, so you must not add
``overlay-dtls.config``. This sample uses IPv4 by default, but you can
use IPv6 by enabling IPv6 and configuring your IP address.

Step 4: Build UpdateHub
=======================
@@ -260,7 +264,7 @@ In the terminal you used for debugging the board, type the following command:

kernel reboot cold

Your board will reboot and then start with the new image. After rebooting the
Your board will reboot and then start with the new image. After rebooting, the
board will automatically ping the server again and the message ``No update
available`` will be printed on the terminal.

@@ -50,4 +50,4 @@ Sample Output
T: 24.589696; P: 97.648366; H: 53.958864; G: 1072.155863
T: 24.856631; P: 97.648322; H: 53.553669; G: 1096.448788

<repeats endlessly>
<repeats endlessly>
@@ -66,4 +66,4 @@ Sample Output
[00:00:03.165,991] <err> ext_log_system: error level log, 1 arguments: 1
[00:00:03.166,006] <wrn> ext_log_system: warning level log, 2 arguments: 12
[00:00:03.166,025] <inf> ext_log_system: notice level log, 3 arguments: 105
[00:00:03.166,044] <inf> ext_log_system: info level log, 4 arguments : 1 24
[00:00:03.166,044] <inf> ext_log_system: info level log, 4 arguments : 1 24
@@ -7,4 +7,4 @@ USB Samples
:maxdepth: 1
:glob:

**/*
**/*

0 comments on commit 6b2cd29

Please sign in to comment.
You can’t perform that action at this time.