Skip to content
elixpoPublic

About

FaleraOS (formerly OreoOS) by Elixpo: open-source MicroPython OS and hardware for the ESP32-S3 Falera Badge, with apps, an App Store, OTA updates, KiCad hardware and RV565 video.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

13 stars

Watchers

0 watching

Forks

Latest commit

ย 

History

621 Commits

Folders and files

NameName
Last commit message
Last commit date
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Lumi, the panda mascot

FaleraOS and the Falera Badge

FaleraOS by Elixpo: an open-source MicroPython operating system for the Falera Badge, a panda-themed ESP32-S3 conference badge.

Formerly OreoOS (until November 2026). Our panda is Lumi.

License: MIT ยท CERN-OHL-P ยท CC-BY-4.0 MicroPython 1.28 ESP32-S3 OTA Updates Fund the badge

OpenSSF Best Practices OpenSSF Scorecard Wikidata arXiv OSHWA certified: IN000107

Featured on Adafruit ยท MA-NO ยท HardLabs ยท USB ID from Espressif ยท more


Hang it on your lanyard. Hand it to a stranger. Swap quests over IR. Watch your commits scroll past. Falera is what happens when a conference name-tag grows up.

Lumi, the panda banner

๐Ÿ’› Help build the first Falera badges

The first five PCBs are being made now, paid for out of pocket. If you'd like to see Falera built, chip in whatever you can, from โ‚น100. Every rupee goes into boards and parts, and everything stays open.

Fund the badge โ†’ payouts.elixpo.com/f/falera-badge


๐ŸŽจ Assets by pollinations.ai

Built with Pollinations

Every sprite, banner, and mascot of the project โ€ Lumi, the badges, the in-app artwork, the website hero โ€ was generated with Pollinations.ai.


๐ŸŒŸ At a glance

๐Ÿ–ฅ 320 ร— 240 IPS display

A 2-inch full-colour LCD running at 33 fps with PWM-dimmed backlight. Every app you write gets the same framebuffer + theme palette.

๐Ÿผ Built-in app SDK

class App(oreoOS.App): with three methods is all it takes. Copy app_templates/, edit, deploy. Your icon shows up in the launcher. Guide: docs/APPS.md.

๐Ÿ“ก Real WiFi + Bluetooth

Weather, GitHub commits, OTA updates โ€” all live. WiFi power-capped at 11 dBm so a bench supply can run it. BLE for badge-to-badge swaps.

๐ŸŽฎ Default apps + an App Store

GitHub tools, a markdown reader, a gallery, storage breakdown. Games, IR quests, weather and more install on-device from the App Store.

๐Ÿ”„ Over-the-air updates

The badge SHA-checks GitHub Releases in the background. Small patches install themselves. Big updates wait for your confirmation.

๐Ÿค Talks to other badges

IR beacons, BLE advertise + scan, a quest system. Hand someone your badge โ€” they hand you back a new app, a new puzzle, a new high score.


๐ŸŽฎ The apps

Every tile in the drawer is its own folder under apps/, written as a small class App(oreoOS.App) with three lifecycle methods. Two trees ship to the badge: apps/ is what's pre-installed, apps_market/ is the catalogue of apps the user can install on-device from the App Store tile.


Badge

Commits

Weather

Racer

Flappy

Snake

Gamepad

Gallery

IR Quest

Reader

Storage

App Store

Settings

About

Bluetooth and WiFi don't get their own drawer tiles โ€” they live inside Settings, alongside brightness, sleep, gestures and OTA. The notification panel (press C from anywhere; apps that use C themselves, like Gamepad, take a double-tap instead) puts both radios + a brightness slider + manual time-sync one tap away.

๐Ÿ“ฆ App Store โ€” install, update and remove apps on-device

The badge ships a small default set (About, Badge, Commits, Gallery, Gamepad, Reader, Settings, Storage, Transfer and the App Store, plus the system apps Apps, Updates and WiFi). Everything else lives under apps_market/ and installs from the App Store tile: Racer, Flappy Lumi, Snake, Lumi (the panda pet), IR Quest, Bluetooth, Weather, Color, Gestures and the Diwali special, Patakha.

  • Discover (first page): a featured card plus every app with its icon, tagline, category, size and an INSTALL / OPEN / UPDATE button. A opens the app's page (author, version, size, description) where you install it, with a progress bar.
  • Installed (press B): every app on the badge. Built-in apps can only be opened; others can be updated or uninstalled behind a confirm dialog, and reinstalled from Discover any time.
  • The catalogue is one file, apps_market/index.json, cached on the badge so the Store opens instantly and refreshes in the background. Apps install into the badge's filesystem, which takes all of the 16 MB flash after the firmware: about 13.7 MB.
# Programmatic API (handy from the REPL):
from oreoOS import store
store.refresh()              # fetch the catalogue
store.install("racer")       # โ†’ (ok, message)
store.uninstall("racer")     # built-in apps are refused

Contribute an app by adding apps_market/<your_app>/ with the usual main.py + manifest.json + __init__.py + src/ + assets/ shape, then run python3 tools/build_store_index.py and add a tagline, description and category to its entry in apps_market/index.json. See apps_market/README.md.

Want yours to be always-installed? Drop it in apps/ instead. Copy app_templates/ as a starting point.


Doom edition

Doom is not part of FaleraOS 2.0: dropping its 7 MB game-data partition gives the filesystem about 13.7 MB. The complete Doom build stays on the doom-edition branch: the engine (doomgeneric / Chocolate Doom, GPL), the Doom app, the Freedoom tooling, the partition layout with the doom partition and a prebuilt firmware image. To put it on a badge (this erases it):

git fetch origin doom-edition && git switch doom-edition
./build-firmware --clean      # or use the prebuilt oreoWare/firmware/OREO_BADGE-v1.28.0.bin
./deploy --full               # firmware, Freedoom data and OS

๐Ÿ’ป Use your badge from a computer

Plug the badge in over USB and install falera-cli, which gives you the falera command. It finds the badge by itself, so you never need to look up a port name.

# Linux, macOS (Windows: irm https://raw.githubusercontent.com/elixpo/falera/main/cli/install.ps1 | iex)
curl --proto '=https' --tlsv1.2 -LsSf https://raw.githubusercontent.com/elixpo/falera/main/cli/install.sh | sh

falera                                   # the full-screen Falera view
falera transfer send photo.jpg notes.md  # with Tools > Transfer open on the badge; type the code it shows
falera wifi connect "Home Net"           # Wi-Fi is for the internet: App Store, updates, GitHub, weather, time
falera update                            # newest FaleraOS, downloaded by the badge

๐Ÿš€ Get going

git clone https://github.com/elixpo/falera
cd falera
python -m venv .venv && source .venv/bin/activate
pip install -r oreoOS/requirements.txt
python tools/deploy.py /dev/ttyACM0      # flash to a connected board

Connecting over USB (which port, the falera CLI, the Transfer app, flashing) is covered in docs/USB.md.

To set your GitHub user, name, timezone and weather location, see docs/PROFILE.md. For writing apps, see docs/APPS.md; for OS internals, CONTRIBUTING.md.

Host tools need Python 3.9 or newer on Linux, macOS, or Windows via WSL. The badge itself runs MicroPython 1.28.

Warm-up (no badge, no keys)

git clone https://github.com/elixpo/falera
cd falera
python3 -m unittest discover -s tests -v

What works: the hardware-free unit tests for pure helpers (colour packing in oreoOS/api.py, .env parsing in oreoOS/config.py). They use only the Python standard library, so no pip install, badge or key is needed. What is skipped: running FaleraOS apps needs an ESP32-S3 badge; there is no desktop simulator yet. With a badge, tools/deploy.py runs without keys and writes blank WiFi and weather values when .env.local is missing. Expected result: OK at the end of the run. If something asks you for a secret, open an issue instead of working around it.

Configuration and access

This repository keeps configuration encrypted with SOPS. Applicants do not need any keys: setup, tests and warm-up tasks run locally without decrypting configuration. Once accepted, contributors receive SOPS access scoped to their work (for example integration tests or staging), revoked when the programme ends. Do not try to decrypt or commit configuration; if setup asks for a secret, open an issue.


๐Ÿ”” The notification panel

Press C from any app. A pink panel slides down with everything you'd otherwise dig through menus for:

Row What it does
WiFi ยท BT ยท Settings three pills โ€” A toggles the radio, or jumps straight to the Settings app
Brightness slider LEFT / RIGHT nudges the LCD backlight by 10 %, no preset cycling
Sync time A re-runs the NTP sync โ€” useful when WiFi just came up or you crossed a timezone
Notification cards newest-first list of OTA / BT / file events; A opens, B clears all

Press C (or HOME) again to dismiss โ€” the underlying app keeps its state and resumes mid-frame.


๐Ÿงฐ Built-in libraries

FaleraOS ships a small batteries-included SDK that every app imports from oreoOS. Three of those are worth a quick tour:

Drawing โ€” d.rect, d.pixel, d.text, d.blit, d.clear

from oreoOS import api, theme

def draw(self, d):
    d.clear(theme.BG)                            # fill cream background
    d.rect(10, 10, 100, 40, theme.PRIMARY, fill=True)
    d.rect(10, 10, 100, 40, theme.GOLD)          # outline (fill=False default)
    d.pixel(60, 30, api.WHITE)                   # single pixel
    d.text("hello!", 14, 20, api.WHITE, scale=2) # framebuf 8ร—8, scaled
    d.text(api.rgb(160, 50, 220), 14, 60, ...)   # arbitrary RGB

The framebuffer is RGB565 big-endian. Build colours with api.rgb(r, g, b) instead of constructing the integer by hand. Theme colours (theme.PRIMARY / theme.GOLD / theme.TEAL / theme.MUTED / โ€ฆ) exist for visual consistency across apps.

Sprites + images โ€” d.blit

def _try_sprite(name):
    try:
        m = __import__("apps.my_app.assets.optimized." + name, None, None,
                       ["DATA", "W", "H"])
        return (bytearray(m.DATA), m.W, m.H)
    except (ImportError, AttributeError):
        return None

def draw(self, d):
    if (s := self._sprite):
        data, w, h = s
        d.blit(data, x, y, w, h)

Sprites are produced by tools/optimize_assets.py from raw PNG / JPG files under apps/my_app/assets/raw/. Pixels equal to chroma-key magenta (0xF81F RGB565) are skipped by blit() โ€” that's how the panda mascot ends up with a transparent backdrop on the splash.

Higher-level text โ€” oreoOS.pixelfont

from oreoOS import pixelfont
font = pixelfont.load("pixelify_16")  # also pixelify_8, _12, _24
font.text(d, "Score: 42", 8, 6, theme.PRIMARY)
w = font.measure("Score: 42")          # for centring

The framebuf's 8ร—8 font is fine for HUDs; the Pixelify Sans bitmaps look better for titles and menus.

Caching network data โ€” oreoOS.cache

from oreoOS import cache
profile, age = cache.load("apps/my_app/cache.txt", ttl_s=3600)
if not profile or age > 3600:
    profile = my_fetch_function()
    cache.save("apps/my_app/cache.txt", profile)

Used by Badge + Commits to render instantly from disk and refresh in the background. Auto-includes a __ts=<epoch> header so callers know the cache age.

Time + NTP sync โ€” oreoOS.timeutil

from oreoOS import timeutil
hour, minute, sec, weekday, day, month, year = timeutil.now()

ok, msg = timeutil.sync_from_ntp()        # ~2 s blocking, gated on WiFi
print(timeutil.last_sync_status())        # "ok" | "no-wifi" | "failed" | "never"

Same call drives the boot-time auto-sync, the Sync Time row in Settings, and the C-panel time-sync action โ€” all three surfaces agree on the last result via the shared last_sync_status().

Storage breakdown โ€” oreoOS.storage

from oreoOS import storage
snap = storage.usage()
# {'stats': {'total': โ€ฆ, 'used': โ€ฆ, 'free': โ€ฆ},
#  'buckets': {'system': {...}, 'apps': {...}, 'gallery': {...},
#              'documents': {...}, 'misc': {...}}}

A full os.listdir + os.stat walk takes a few hundred ms on a populated 16 MB flash, so the Storage app declares SHOW_LOADING = True to mask the blocking call behind the slide splash. Use it from any app that wants a "how full am I?" readout.

Markdown rendering โ€” the Reader app

The Reader app (apps/reader/) renders .md and .txt files copied to documents/ over USB or flashed into apps/reader/assets/. Supports # / ## / ### headings, **bold**, *italic*, `code`, bullets, numbered lists, fenced ``` blocks, and --- rules โ€” small enough to ship to flash, big enough for README-style notes. New files appear in the picker within 200 ms (5 Hz poll) โ€” no restart.

Wireless networking and Bluetooth

FaleraOS leans on MicroPython's stock networking stack; the FaleraOS wrappers (oreoWare.wifi, oreoWare.bt) add config handling and power capping on top.

  • WiFi โ€” network.WLAN. Wi-Fi is for the internet only (App Store, updates, GitHub data, weather, the clock). Networks are added over USB with the falera CLI (see docs/CLI.md) or at deploy time from .env.local (WIFI_SSID, WIFI_PASSWORD; see .env.example); the OS applies wlan.config(txpower=โ€ฆ) and pm=PM_POWERSAVE from oreoOS/config.py so a sealed badge doesn't melt its LDO.
  • Bluetooth โ€” bluetooth. Bluetooth is the last feature on the roadmap (#124); files go over USB for now. The current build advertises as Falera and exposes a tiny GATT "transfer" service so a paired device can push one image (max 250 KB) or one text document (deflate-compressed) at a time. Images land in apps/gallery/assets/raw/, text in documents/. BLE adv interval is capped by BT_ADV_INTERVAL_MS to keep average current draw down.
# WiFi via the FaleraOS wrapper โ€” auto-applies power caps from config
from oreoWare import wifi
wifi.connect_from_config()
print(wifi.ip())

# Or drop straight to stock MicroPython:
import network
wlan = network.WLAN(network.STA_IF)
wlan.active(True)
wlan.connect("SSID", "password")
# BLE advertise (raw stdlib path)
import bluetooth
ble = bluetooth.BLE()
ble.active(True)
ble.gap_advertise(500_000, b"\x02\x01\x06\x05\x09Oreo")

Pushing files to the badge. Connect to "Falera", then write to the RX characteristic in chunks. Frame format:

+------+-------------------+-----------+-------------+
| type | length (4B BE)    | payload   | crc32 (4B)  |
+------+-------------------+-----------+-------------+
  'I'  =  image,    raw bytes, length โ‰ค 250 KB
  'T'  =  text,     deflate-compressed UTF-8 โ†’ documents/*.txt
  'M'  =  markdown, deflate-compressed UTF-8 โ†’ documents/*.md

The TX characteristic notifies a single-byte status (0x02 = done, 0xE1 = too large, 0xE2 = bad CRC, โ€ฆ). See oreoWare/bt.py for the full UUID + status table.

Built-in modules

Every stock MicroPython module is available to apps โ€” no extra install step. The ones you'll actually reach for on badge work:

array, binascii, builtins, cmath, collections, errno, gc, hashlib, heapq, io, json, machine, math, micropython, network, os, platform, random, re, select, socket, ssl, struct, sys, time, uctypes, bluetooth, cryptolib, deflate, framebuf, vfs, ntptime, requests, urequests, asyncio, aioble, websocket, umqtt, webrepl.

On top of those, FaleraOS ships its own helper packages: oreoOS.* (font, sprite, cache, theme, widgets, ota, powerโ€ฆ) and oreoWare.* (display, buttons, wifi, bt, imu, ir, battery, pins). Import them from any app โ€” they're on the device boot path.


๐Ÿ–ผ Gallery โ€” flashing your own photos

The Gallery app cycles through pictures you ship with the badge. Workflow:

# 1. Drop pictures into apps/gallery/assets/raw/
cp ~/Pictures/team-offsite.jpg apps/gallery/assets/raw/

# 2. Bake them to RGB565 (preserves aspect ratio, fits 320ร—196 play area)
python tools/optimize_assets.py --app gallery

# 3. Push to the badge โ€” the deploy step also prunes any stale photos
#    the user deleted from raw/ so the device stays in sync.
python tools/deploy.py /dev/ttyACM0

The optimizer accepts .png, .jpg, and .jpeg. Photos are aspect-preserved (no forced square crop). On the badge, L/R cycles photos, and the last tile is a + help screen that walks any user through this exact workflow.


๐Ÿ›  Hardware

FaleraOS runs today on a breadboard badge built from an ESP32-S3 DevKitC. The PCB badge, designed in KiCad under circuit/elixpo/, is finished: the first five boards were ordered in November 2026, and FaleraOS is flashed onto it once a board is assembled.

Falera badge PCB, front Falera badge PCB, back
Breadboard badge (runs today) PCB badge (first boards ordered)
MCU ESP32-S3-DevKitC-1-N16R8 ESP32-S3-WROOM-1-N16R8 (16 MB flash, 8 MB PSRAM)
Display ST7789 IPS, 2.0", 320ร—240 ILI9341 2.8", 320ร—240, resistive touch, on its own 5 V boost
Input 8 buttons on GPIOs 8 buttons on an AW9523B IยฒC expander, plus RESET and BOOT
Sensors MPU-6050, TSOP38238 IR receiver MPU-6050 (IยฒC 0x69), TSOP38238 IR receiver
Output 4 corner LEDs, WS2812 status LED, IR LED 4 corner LEDs (each with 2 more on the back edge), WS2812B status LED, IR LED, MAX98357A amp and speaker
Storage โ€” microSD (1-bit SDMMC)
Expansion โ€” Qwiic (IยฒC) and a 4-GPIO header (IยฒC, SPI or GPIO)
Comms Wi-Fi, BLE 5.0, IR, USB-C Wi-Fi, BLE 5.0, IR, native USB-C
Power 18650 + MAX17048, AMS1117-3.3 LiPo with BQ24074 USB-C charger, TPS63031 3.3 V buck-boost
Clock RTC backed by NTP ESP32 clock, set by NTP after a cold start
Board โ€” 4 layers, 88 ร— 133.5 mm, OSHWA-certified (IN000107)

The PCB's design notes, pin map and ordering steps are in circuit/elixpo/README.md, and the parts and cost of one badge in circuit/elixpo/BOM_COST.md.

๐Ÿ“„ Full electrical / mechanical specs: see docs/DATASHEET.md ๐Ÿ”ง Build guide + pinout + soldering tips: see docs/HARDWARE.md

The single source of truth for every GPIO assignment is oreoWare/pins.py โ€” one file, one line per pin.


๐Ÿ”„ Updates

The badge pulls itself forward. A fast SHA-vs-version check runs in the background against the project's GitHub release channel. Small patches (โ‰ค 80 KB) install themselves; big updates wait for your explicit yes. Files are validated by SHA-256 and atomically swapped on the next boot โ€” if anything goes wrong mid-download, the badge keeps running its old version.

Every HTTPS connection verifies the server's certificate (chain, host name and dates) against a small bundle of root CAs shipped with the OS, so a network attacker cannot fake an update or an App Store download. Verification needs the real date, so the badge syncs its clock over NTP before the first secure request; if the certificate or the clock can't be checked, the Updates and App Store screens say so (TLS: ...) instead of connecting anyway. Hosts, roots and fingerprints: docs/TLS.md.

Wall-clock time follows the same pattern: NTP runs once at boot when WiFi is up, and the Sync Time action (Settings or the C-panel) lets you re-pull if you crossed a timezone or the clock drifted.

Cutting a release takes one command: python tools/release.py. Details in CONTRIBUTING.md โ†’ Releasing.


๐ŸŽž RV565 โ€” the badge's video format, for any project

The Gallery's video playback grew into RV565, a standalone library and file format for smooth video on ESP32 SPI displays (24 FPS with zero missed frames on the ESP32-S3; arXiv:2610.35935). It lives in its own repository, elixpo/rv565, and installs from the official channels:

Where How
Arduino Library Manager โ†’ RV565, or arduino-cli lib install RV565
Python (desktop) pip install rv565 โ€” on PyPI, with a Pillow plugin via pip install "rv565[pillow]"
ESP-IDF idf.py add-dependency "elixpo/rv565" โ€” ESP Component Registry
CircuitPython circup install circuitpython_rv565 โ€” elixpo/CircuitPython_RV565, docs
Browser falera.elixpo.com/rv565/convert โ€” convert a video with no install and no upload

๐Ÿ“š Reading order

๐Ÿ‘‹ Just want to use it? this README + docs/HARDWARE.md
๐Ÿ”Œ Connecting it to a computer? docs/USB.md + docs/CLI.md: the falera CLI, Transfer, flashing
๐Ÿง‘โ€๐Ÿ’ป Want to write an app? docs/APPS.md + app_templates/
๐Ÿ”Œ Building your own PCB? docs/DATASHEET.md + oreoWare/pins.py
๐Ÿค Joining the community? CODE_OF_CONDUCT.md + SUPPORT.md
๐Ÿ›ก Found a vulnerability? docs/SECURITY.md
๐Ÿ“– Citing FaleraOS or RV565? CITATION.cff + paper/

A docs index lives at docs/README.md.


๐Ÿ™Œ Contributing

We love new contributors. The bar is low; the welcome is warm.


The Falera family

One project in three repositories, grouped under the oreo-badge topic:


The ecosystem

Falera Badge is part of Elixpo - an open, ethical, and accessible ecosystem of AI and developer tools, built by a global community of 45+ contributors.

Tool What it does Link
๐ŸŽจ Elixpo Art AI image generation (under dev) art.elixpo.com
โœ๏ธ Elixpo Blogs A rich, modern writing and publishing space blogs.elixpo.com
๐Ÿ–Š๏ธ LixSketch A hand-drawn style whiteboard for ideas and diagrams sketch.elixpo.com
๐Ÿ’ฌ Elixpo Chat A fluid, real-time AI chat experience (under dev) chat.elixpo.com
๐Ÿ”Ž Elixpo Search Fast, AI-assisted search search.elixpo.com
๐Ÿ‘ค Elixpo Accounts One identity (SSO) across the ecosystem accounts.elixpo.com
๐Ÿ”— lixrl Our flagship URL shortener lixrl.com
๐Ÿชช Portfolios Personal pages to showcase your work me.elixpo.com
๐Ÿผ Lumi The mascot's home falera.elixpo.com

Built by the community

Elixpo is made by people, in the open. 45+ contributors have shaped these tools, with a small core team steering the way:

Everyone is welcome. See CONTRIBUTING.md and our Code of Conduct.

๐Ÿ“ฐ In the press

Coverage

Recognised upstream

Published

FaleraOS is an open-source MicroPython operating system for the Elixpo Falera Badge. It is not related to Android 8.0 Oreo or to OREOยฎ cookies, a trademark of Mondelฤ“z International.

Recognition & programs

Elixpo has taken part in and been supported by GSSOC, Hacktoberfest, Pollinations.AI, MS Startup Foundations, and OSCI.

FaleraOS is recorded on Wikidata as FaleraOS (Q141968869), an embedded operating system based on MicroPython. Its video pipeline is described in the paper RV565 (arXiv:2610.35935), and the playback library is published separately as RV565 (Arduino Library Manager, ESP Component Registry, PyPI, CircuitPython).

Written about

Submitted, under review

Google Summer of Code 2027

Elixpo is applying to be a mentoring organisation for Google Summer of Code 2027. Google has not announced the 2027 programme yet, and Elixpo has not been accepted. Falera hosts one proposed project idea:

Idea Size Difficulty Mentors (primary / backup)
Falera badge simulator and CLI test bench 175 h Intermediate Ayushman Bhattacharya / Vivek Yadav

How to start (no badge hardware needed)

  1. Read the idea page and the programme site at gsoc.elixpo.com.
  2. Run the tests (python3 -m unittest discover -s tests and python3 tools/validate_app.py, standard library only), install the CLI from the checkout (pip install -e cli/) and try falera new my_app. Read docs/LEARN.md for a guided tour of FaleraOS.
  3. Read docs/CLI.md, docs/README.md and docs/HARDWARE.md: the simulator stands in for the display and buttons, and answers the falera CLI like a badge.
  4. Read CONTRIBUTING.md, then pick a small issue from the issue tracker.

Configuration and access

This repository keeps configuration encrypted with SOPS. Applicants do not need any keys: the warm-up tasks and the core of the idea run locally without decrypting configuration. Once accepted, contributors receive SOPS access scoped to their project (for example for integration tests or staging), which is revoked when the programme ends.

Questions go to gsoc@elixpo.com. GitHub Discussions for GSoC open once Google announces the 2027 dates.

Google Summer of Code is a programme of Google LLC; Elixpo is applying as a mentoring organisation and is not affiliated with or endorsed by Google.

Get involved

  • ๐Ÿ’ฌ Join the conversation in GitHub Discussions.
  • ๐Ÿš€ Submit your project to be featured across the ecosystem.
  • ๐Ÿ› ๏ธ Contribute - browse good first issues in the monorepo.

Brand assets

The Lumi mascot, badge sprites, and app icons live under assets/. They are CC-BY-4.0, but the Lumi mascot, the chest E-badge, and the "Elixpo"/"Falera" names are trademarks - see TRADEMARKS.md. A browsable brand kit is at elixpo.com/assets.

License

The Falera Badge is certified open source hardware by the Open Source Hardware Association, UID IN000107.

Certified open source hardware, OSHWA UID IN000107

Dedication. FaleraOS is dedicated to @anwe-ch, for its full runtime. Read why in the preamble.

Psst: she is the co-author of RV565, the video format the Gallery plays.

  • Code (FaleraOS, oreoWare, apps, tooling) - MIT.
  • Hardware (KiCad schematics, PCB, symbols, BOMs and generated files under circuit/) - CERN-OHL-P-2.0, the permissive CERN Open Hardware Licence.
  • Brand & visual assets (mascot, sprites, icons) - CC-BY-4.0.
  • Upstream firmware components - the firmware image incorporates MicroPython (MIT) and Espressif ESP-IDF (Apache-2.0); downstream distributors of compiled firmware must retain those licenses. See LICENSES/notices/notice-board.

The Lumi mascot, the chest E-badge, the "Elixpo", "Falera", "Falera Badge", and "FaleraOS" names, and the elixpo.com domains are trademarks of the Elixpo project and are not licensed by MIT, CERN-OHL-P-2.0 or CC-BY-4.0. See TRADEMARKS.md and the per-product notice board, LICENSES/NOTICE.

Exclusive

This repository ships firmware and hardware. The files are open (MIT, CERN-OHL-P-2.0, CC-BY-4.0); what Elixpo reserves is identity, not the design (full text in LICENSES/NOTICE):

  • The faleraos and oreoos published package names.
  • The official firmware / OTA release bundles distributed from GitHub Releases and the "Falera" OTA identity.
  • The Falera Badge name and look: the "Falera Badge" product name, the panda mascot and the chest E-badge.

You may build, modify, sell and redistribute boards and firmware made from the open design files - just not under the reserved Elixpo / Falera names or mascot.


With ๐Ÿ’– by Ayushman Bhattacharya.

Want to help, ship an app, sponsor a build, or just say hi - โœ‰๏ธ hello@elixpo.com

About

FaleraOS (formerly OreoOS) by Elixpo: open-source MicroPython OS and hardware for the ESP32-S3 Falera Badge, with apps, an App Store, OTA updates, KiCad hardware and RV565 video.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

13 stars

Watchers

0 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages