Skip to content

Latest commit

 

History

History

README.md

omiGlass Front View

Overview

omiGlass is an open-source smart glasses project that gives you AI capabilities with exceptional battery life.

Longer lasting than Meta Ray-Bans Powerful XIAO microcontroller with camera Hardware, firmware, and software Watch the [announcement video](https://x.com/kodjima33/status/1911852469329727811) to see omiGlass in action.

Prerequisites

Local AI model hosting For firmware upload For hardware components

Software Setup

```bash git clone https://github.com/BasedHardware/omi.git cd omi/OmiGlass npm install ```
Or with yarn:
```bash
yarn install
```
Copy the template and add your keys:
```bash
cp .env.template .env
```

Edit `.env` and add:
- [Groq API key](https://console.groq.com/keys)
- [OpenAI API key](https://platform.openai.com/api-keys)
- Ollama URL (default: `http://localhost:11434/api/chat`)
```bash ollama pull moondream:1.8b-v2-fp16 ``` ```bash npm start ```
Or with yarn:
```bash
yarn start
```

<Tip>
This is an Expo project. Open the localhost link displayed after starting to access the web version.
</Tip>

Firmware Installation

Open the [firmware folder](https://github.com/BasedHardware/omi/tree/main/omiGlass/firmware) and load the `.ino` file in Arduino IDE.
<Tip>
Alternatively, follow the [firmware readme](https://github.com/BasedHardware/omi/tree/main/omiGlass/firmware/readme.md) to build using `arduino-cli`.
</Tip>
Add the ESP32 board package:
1. Go to **File → Preferences**
2. Add to "Additional Boards Manager URLs":
   ```
   https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
   ```
3. Go to **Tools → Board → Boards Manager**
4. Search for `esp32` and install the latest version
1. Select port (likely COM3 or higher) at the top of Arduino IDE 2. Search for `xiao` in the board selector 3. Select **XIAO_ESP32S3** Go to **Tools** dropdown and set **PSRAM** to **OPI PSRAM**.
<Frame>
  <img src="/images/docs/hardware/images/image.png" alt="PSRAM Settings" />
</Frame>
Click the Upload button to flash the firmware to your XIAO ESP32S3 board.

License

This project is licensed under the MIT License.