https://github.com/giacomocavalieri/orbital

⚛️ Build and flash Gleam projects to devices running AtomVM
https://github.com/giacomocavalieri/orbital

atomvm gleam iot

Last synced: about 1 month ago
JSON representation

⚛️ Build and flash Gleam projects to devices running AtomVM

• Host: GitHub
• URL: https://github.com/giacomocavalieri/orbital
• Owner: giacomocavalieri
• License: apache-2.0
• Created: 2026-03-16T14:59:21.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2026-04-13T09:09:27.000Z (about 2 months ago)
• Last Synced: 2026-04-13T10:16:39.969Z (about 2 months ago)
• Topics: atomvm, gleam, iot
• Language: Gleam
• Homepage: https://hexdocs.pm/orbital/
• Size: 43 KB
• Stars: 38
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ⚛️ orbital

[![Package Version](https://img.shields.io/hexpm/v/orbital)](https://hex.pm/packages/orbital)

[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/orbital/)

Build and flash Gleam projects to devices running [AtomVM](https://atomvm.org).

![A video showcasing the 'orbital' workflow:

The command 'gleam run -m orbital flash esp32 --port /dev/tty.usbserial001'

is ran in a terminal window.

After a short while the message 'Done' is displayed and the command

'screen' is ran to show that the code was flashed and is running on an esp device

](https://github.com/user-attachments/assets/5c50358e-31a3-443e-b2da-2f12a58d356b)

Add it to your project as a dev dependency:

```sh

gleam add --dev orbital

```

Your project must have a module with a `start` function that takes no arguments:

```gleam

import gleam/io

pub fn start() {

  io.println("Hello, from AtomVM!")

}

```

To build and flash it to a device with the AtomVM firmware installed you can

run:

```sh

gleam run -m orbital flash esp32 --port /dev/some_device

```

And you're good to go! To get an overview of all the available commands and

options you can run:

```sh

gleam run -m orbital help

```

## FAQ

- **What's AtomVM?**

  AtomVM is a lightweight implementation of the BEAM, optimized to run on tiny

  micro-controllers. You can read more about it [here!](https://atomvm.org)

- **How can I install AtomVM?**

  To install AtomVM on a device check the

  [getting started guide.](https://doc.atomvm.org/latest/getting-started-guide.html)

- **Can I run any Gleam program on AtomVM?**

  AtomVM implements a constrained subset of the Erlang's standard library, so if

  your Gleam code or dependencies use some of the functions that are not

  supported you will see a runtime error once running it on the device!

  If you see an `undef` error in your stack trace, that most likely means your

  code used one such function.

- **What can I do to help?**

  AtomVM is a wicked cool project, enabling developers to run Erlang, Elixir and

  Gleam code on tiny embedded devices, as cheap as 2$!

  If you think this project is cool, please

  [consider sponsoring it!](https://github.com/sponsors/atomvm)