Skip to content

Commit

Permalink
getting started: add Device Examples section
Browse files Browse the repository at this point in the history
Add a rudimentary set of Device Examples guides to the Getting Started section.
These need fleshing out, but will walk user through running precompiled binaries
and compiling example apps.

Signed-off-by: Mike Szczys <mike@golioth.io>
  • Loading branch information
szczys committed Nov 28, 2023
1 parent 477e1d2 commit 2be841a
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Running Pre-compiled Binaries
sidebar_position: 1
description: Try Golioth without needing to compile
---

Golioth currently offers pre-compiled binaries for three different devices:

* Nordic Thingy:91
* Nordic nRF9160 DK
* Nordic nRF7002 DK

:::tip There are many other options

If you do not have one of these devices available, you can still run Golioth
example code by compiling it yourself. Please see the [Compiling Example
Code](/getting-started/device-examples/compile-example-code) section of the
Getting Started guide.

:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Compiling Example Code
sidebar_position: 2
description: |
Compile our well-tested example code for your favorite embedded device.
---

Golioth will work with a vast number of different microcontrollers. This section
will guide you through the process of compiling samples from our device SDKs to
run on your chosen hardware.

Select your desired platform to build example code

* Zephyr RTOS
* ESP-IDF
* ModusToolbox&trade;

:::info Hardware we continuously verify

Golioth maintains a special level of support for a number of different
development boards using Hardware-in-the-Loop testing. You will find a fast path
to success by testing Golioth using one of these boards:

* Espressif ESP32-devkitc/ESP32S3-devkitc/ESP32C3-devkitm
* Nordic nRF9160DK
* Nordic nRF52840 + ESP32 (AT Modem)
* NXP mimxrt1024-evk

:::
24 changes: 24 additions & 0 deletions docs/getting-started/3-device-examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Device Examples
sidebar_position: 3
---

# Run Example Code on Your Hardware

Golioth works on literally hundreds of devices.

If your target microcontroller can run Zephyr, ESP-IDF, or ModusToolbox&trade;,
it will work well with Golioth. Even if you need a device that doesn't work on
any of these platforms, we have [an SDK porting
guide](https://github.com/golioth/golioth-firmware-sdk/blob/main/docs/Porting_Guide.md)
you can use to add support.

However, we know you want to take Golioth for a test-drive right now. And that's
no problem. We recommend you try out some of our sample code. There are two
options for this, you can run a pre-compiled binary to add a device to your
Golioth fleet, or compile one of the many sample applications in our device
SDKs.

import DocCardList from '@theme/DocCardList';

<DocCardList />

0 comments on commit 2be841a

Please sign in to comment.