docs: embedded: getting_started: added #483
Conversation
|
|
||
| To use vscode (Visual Studio Code): | ||
|
|
||
| 1. Install and Open VScode from Windows (not WSL). |
There was a problem hiding this comment.
Doc build error here:
infuse-sdk/doc/_build/src/embedded/getting_started/index.rst:369: WARNING: Enumerated list ends without a blank line; unexpected unindent.
There was a problem hiding this comment.
Lists in rst are confusing.
Didn't realise it stopped outputting errors and had to make clean to make them reappear.
|
|
||
| Follow this guide to: | ||
|
|
||
| - Set up a command-line Infuse IoT Emebdded development environment on Ubuntu, macOS, or |
| Sample" steps. | ||
|
|
||
| Setup Python environment | ||
| ***************************************** |
There was a problem hiding this comment.
Should only be as long as the title
There was a problem hiding this comment.
Turns out at some point I Ctrl+clicked the file reference in a warning to go to the location, but it opened the file from the _build folder.
Was really confusing why my changes were magically undoing themselves.
|
|
||
| .. note:: | ||
|
|
||
| Installing Zephyr requires a many dependencies and by default installs all of them which |
There was a problem hiding this comment.
this is not a complete sentence that makes sense
| .. _host_setup: | ||
|
|
||
| Setup and Install `Zephyr RTOS <https://www.zephyrproject.org/>`_ | ||
| ***************************************************************** |
There was a problem hiding this comment.
This entire section should just be a link to the Zephyr setup steps IMO.
Once baseline zephyr is setup:
- Clone out infuse-sdk into the workspace
- Set
infuse-sdkas the manifest folder (edit.west/config,[manifest] path) west update- Ensure
west build -b nrf52840dk/nrf52840 infuse-sdk/app/gateway_usbbuilds
Trying to copy extra information from the Zephyr website is just likely to go out of date.
| Setup Build Directory (Optional) | ||
| ******************************** | ||
|
|
||
| .. note:: |
There was a problem hiding this comment.
Note should go at the end
|
|
||
| .. group-tab:: macOS | ||
|
|
||
| - Install ``binutils`` through brew for useful tools such as ``addr2line``. |
There was a problem hiding this comment.
Proper toolchain versions of addr2line are installed as part of the Zephyr SDK
Aeyohan
force-pushed
the
feature/getting_started
branch
from
cafab3d to
28521a0
Compare
|
doc/getting_started/embedded.rst
Outdated
|
|
||
| Follow this guide to: | ||
|
|
||
| - Set up a command-line Infuse-IoT Embedded development environment on Ubuntu, macOS, or |
There was a problem hiding this comment.
Probably drop the OS mentions, there shouldn't be anything stopping this working on native Windows as well, its a supported Zephyr platform.
doc/getting_started/embedded.rst
Outdated
|
|
||
| Zephyr's install instructions uses the workspace: ``~/zephyrproject``. We | ||
| recommend using the workspace: ``~/code/infuse-iot`` instead (but you're welcome to replace | ||
| this path with your own desired desintation, at your own risk). |
There was a problem hiding this comment.
| this path with your own desired desintation, at your own risk). | |
| this path with your own desired destination, at your own risk). |
doc/getting_started/embedded.rst
Outdated
| The first step is to setup and install Zephyr RTOS. | ||
| Install and test Zephyr is working by building the Blinky sample application. | ||
|
|
||
| .. note:: |
There was a problem hiding this comment.
I would drop this entire note, and the OS specific sections below.
Step 1, complete the Zephyr getting started guide (With a note that it can be skipped if you already have a working Zephyr install).
Step 2, create a new workspace for Infuse-IoT now that upstream Zephyr is installed, which should only require:
mkdir ~/infuse
cd ~/infuse
west init -m [email protected]:Embeint/infuse-sdk.git
west update
The goal is to offload as much information as possible to the Zephyr docs, there is no value in duplicating information here that can go out of date faster.
doc/getting_started/embedded.rst
Outdated
|
|
||
| nRF Command line tools will eventually be replaced by `nrfutil`_. | ||
|
|
||
| .. tabs:: |
There was a problem hiding this comment.
Install instructions should be deferred to Nordic instructions, not duplicated here.
Aeyohan
force-pushed
the
feature/getting_started
branch
from
28521a0 to
6cee418
Compare
|
Removed `struct` from recently added documentation references. Caused build errors when building docs Signed-off-by: Aeyohan Furtado <[email protected]>
Added a very basic getting started guide to the docs. Signed-off-by: Aeyohan Furtado <[email protected]>
Aeyohan
force-pushed
the
feature/getting_started
branch
from
6cee418 to
2f79f57
Compare
|
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
2 participants
Added a very basic getting started guide to the docs. Will likely need to be updated once zephyr is updated to 4.0/4.1 due to additions to the
westtool, and changes to zephyr docs as a result.It's also worth noting that I don't remember exactly where setting up the python tools fits in (i.e. can a basic infuse app be built and programmed without setting up python tooling).
Obviously, I reference the gateway_usb which needs python tooling to check the firmware is working, but that would fit well into a next steps guide/demo.