https://github.com/mnishiguchi/hello_poncho
https://github.com/mnishiguchi/hello_poncho
elixir nerves-project phoenix-framework phoenix-liveview raspberrypi
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/mnishiguchi/hello_poncho
- Owner: mnishiguchi
- Created: 2021-06-12T17:28:25.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-06-12T19:43:18.000Z (about 5 years ago)
- Last Synced: 2025-10-06T20:48:00.140Z (9 months ago)
- Topics: elixir, nerves-project, phoenix-framework, phoenix-liveview, raspberrypi
- Language: Elixir
- Homepage: https://dev.to/mnishiguchi/elixir-poncho-project-with-nerves-firmware-and-phoenix-liveview-ui-48k
- Size: 42 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
The content of this file is adopted from [nerves-project/nerves_examples](https://github.com/nerves-project/nerves_examples/tree/main/hello_phoenix).
# Hello Poncho
This example demonstrates a basic poncho project for deploying a [Phoenix
Framework]-based application to a Nerves device. A "poncho project" is similar
to an umbrella project except that it's actually multiple separate-but-related
Elixir apps that use `path` dependencies instead of `in_umbrella` dependencies.
You can read more about the motivations behind this concept on the
embedded-elixir blog post about [Poncho Projects].
## Hardware
This example serves a Phoenix-based web page over the network. The steps below
assume you are using a Raspberry Pi Zero, which allows you to connect a single
USB cable to the port marked "USB" to get both network and serial console
access to the device. By default, this example will use the virtual Ethernet
interface provided by the USB cable, assign an IP address automatically, and
make it discoverable using mDNS (Bonjour). For more information about how to
configure the network settings for your environment, including WiFi settings,
see the [`vintage_net` documentation](https://hexdocs.pm/vintage_net/).
## How to Use this Repository
1. Connect your target hardware to your host computer or network as described
above
2. Prepare your Phoenix project to build JavaScript and CSS assets:
```bash
# These steps only need to be done once.
cd hello_poncho_ui
mix deps.get
npm install --prefix assets
```
3. Build your assets and prepare them for deployment to the firmware:
```bash
# Still in hello_poncho_ui directory from the prior step.
# These steps need to be repeated when you change JS or CSS files.
npm install --prefix assets --production
npm run deploy --prefix assets
mix phx.digest
```
4. Change to the `hello_poncho_firmware` app directory
```bash
cd ../hello_poncho_firmware
```
5. Specify your target and other environment variables as needed:
```bash
export MIX_TARGET=rpi0
# If you're using WiFi:
# export WIFI_SSID=your_wifi_name
# export WIFI_PSK=your_wifi_password
```
6. Get dependencies, build firmware, and burn it to an SD card:
```bash
mix deps.get
mix firmware
mix firmware.burn
```
7. Insert the SD card into your target board and connect the USB cable or otherwise power it on
8. Wait for it to finish booting (5-10 seconds)
9. Open a browser window on your host computer to `http://nerves.local/`
10. You should see a "Welcome to Phoenix!" page
[Phoenix Framework]: http://www.phoenixframework.org/
[Poncho Projects]: http://embedded-elixir.com/post/2017-05-19-poncho-projects/
## Learn More
* Official docs: https://hexdocs.pm/nerves/getting-started.html
* Official website: https://nerves-project.org/
* Discussion Slack elixir-lang #nerves ([Invite](https://elixir-slackin.herokuapp.com/))
* Source: https://github.com/nerves-project/nerves