Skip to content

Commit f057c44

Browse files
committed
Updated docs and links
Signed-off-by: Fred Dushin <fred@dushin.net>
1 parent de93ab5 commit f057c44

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

examples/dht_example/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ The `dht_example` program illustrates use of the DHT API by taking a temperature
88

99
For this application, you will need:
1010

11-
* An ESP32 device, flashed with the [AtomVM](https://github.com/bettio/AtomVM) image (including the VM and core libraries), and capable of connecting via UART to your development machine;
11+
* An ESP32 device, flashed with the [AtomVM](https://github.com/atomvm/AtomVM) image (including the VM and core libraries), containing the `atomvm_dht` Nif, and capable of connecting via UART to your development machine;
1212
* A DHT11 or DHT22 device, typically marketed as an integrated development board;
1313
* The [`esptool.py`](https://github.com/espressif/esptool) tool (for flashing);
1414
* The [`git`](https://git-scm.com) version control tool;
1515
* [Erlang/OTP 21](https://www.erlang.org) or higher, along with [`rebar3`](https://www.rebar3.org);
1616
* A serial monitor program of your choice (e.g, [`minicom`](https://en.wikipedia.org/wiki/Minicom))
1717

18-
While the [IDF SDK](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/) and required toolchains are not required, they may make life a little easier.
18+
> Note that you will need to build a version of the AtomVM virtual machine that includes the `atomvm_dht` Nif.
1919
2020
## Getting Started
2121

@@ -37,9 +37,9 @@ To run this example program, connect the positive (+) lead on the DHT device to
3737

3838
To build and flash this application to your ESP32 device, issue the `esp32_flash` target to the `rebar3` command, and optionally specify the device port and baud rate, if they do not match the defaults.
3939

40-
> Note. For information about the `esp32_flash` target, see the [`atomvm_rebar3_plugin`](https://github.com/atomvm/atomvm_rebar3_plugin) instructions.
40+
> Note. For information about the `esp32_flash` target, see the [`atomvm_rebar3_plugin`](https://atomvm.github.io/atomvm_rebar3_plugin) instructions.
4141
42-
shell$ rebar3 esp32_flash -p /dev/ttyUSB0 -b 115200
42+
shell$ rebar3 atomvm esp32_flash -p /dev/ttyUSB0 -b 115200
4343
===> Fetching atomvm_rebar3_plugin
4444
===> Fetching packbeam
4545
===> Analyzing applications...

markdown/dht.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ The AtomVM DHT library is only supported on the ESP32 platform.
1010

1111
The AtomVM DHT library is implemented as an AtomVM component, which includes some native C code that must be linked into the ESP32 AtomVM image. In order to build and deploy this client code, you must build an AtomVM binary image with this component included.
1212

13-
For general instructions about how to build AtomVM and include third-party components into an AtomVM image, see the [AtomVM Build Instructions](https://doc.atomvm.net/build-instructions.html).
13+
For general instructions about how to build AtomVM and include third-party components into an AtomVM image, see the [AtomVM Build Instructions](https://www.atomvm.net/doc/master/build-instructions.html).
1414

15-
Once the AtomVM image including this component has been built, you can flash the image to your ESP32 device. For instructions about how to flash AtomVM images to your ESP32 device, see the AtomVM [Getting Started Guide](https://doc.atomvm.net/getting-started-guide.html).
15+
Once the AtomVM image including this component has been built, you can flash the image to your ESP32 device. For instructions about how to flash AtomVM images to your ESP32 device, see the AtomVM [Getting Started Guide](https://www.atomvm.net/doc/master/getting-started-guide.html).
1616

17-
Once the AtomVM image including this component has been flashed to your ESP32 device, you can then include this project into your [`rebar3`](https://www.rebar3.org) project using the [`atomvm_rebar3_plugin`](https://github.com/atomvm/atomvm_rebar3_plugin), which provides targets for building AtomVM packbeam files and flashing them to your device.
17+
Once the AtomVM image including this component has been flashed to your ESP32 device, you can then include this project into your [`rebar3`](https://www.rebar3.org) project using the [`atomvm_rebar3_plugin`](https://atomvm.github.io/atomvm_rebar3_plugin), which provides targets for building AtomVM packbeam files and flashing them to your device.
1818

1919
## Programmer's Guide
2020

0 commit comments

Comments
 (0)