Welcome!
Introduction
Thanks for trying out Nerves Livebook!
With this Livebook image, you can work through tutorials, create your own code notebooks and save them on device, and import notebooks from others. We’re just getting started and are super excited with what Livebook can already do. We hope that you’ll enjoy learning about embedded systems and working with hardware in the notebook environment too!
Getting started
You’ve already figured out how to install the Nerves Livebook to your device and how to open this file, so you’re well on your way!
The next steps are to try out the notebooks in the samples directory. They’re all read-only so you’ll need to fork them just like you did to open this file. Livebook and Nerves Livebook are rapidly evolving so some notebooks are a work-in-progress. We recommend starting with the following:
- Configure WiFi - connect to a WiFi access point
- LEDs - learn about the built-in LEDs on your device
- VintageNet - learn about networking on Nerves devices
- Firmware Update - download the latest Nerves Livebook firmware
Saving and copying files
This file and the samples are read-only since they’re built into Nerves
Livebook. Your files can be saved anywhere in /data
which is writable like a
drive on your computer. Firmware updates using the firmware_update.livemd
won’t erase your files. Be careful, though, if you remove the MicroSD card and
re-initialize it in your computer. That will erase them.
If you want to copy a file off the Nerves Livebook image, open up a shell on
your computer and run sftp livebook@nerves.local
. The password is nerves
.
Once you’re logged in, navigate to /data/livebook
or where ever you stored
your files and run get
to copy them off.
Limitations
If you’ve used Livebook before, the Nerves Livebook image has a few differences:
- All code gets evaluated in one Erlang VM. This is convenient for Nerves devices, but you may be surprised when a module defined in one notebook is then accessible in another.
-
Installing hex dependencies is not supported. Nerves Livebook includes many
libraries as a convenience, though. We still recommend using
Mix.install/1
to document what dependencies your notebook requires, but if the dependency is not already loaded, it will raise an error. For the time being, please file an issue or make a PR to include new libraries in the main image.
Learn more
- Official docs: https://hexdocs.pm/nerves/getting-started.html
- Official website: https://nerves-project.org/
- Forum: https://elixirforum.com/c/nerves-forum
- Discussion Slack elixir-lang #nerves (Invite)
- Source: https://github.com/nerves-project/nerves