Skip to content

Latest commit

 

History

History
executable file
·
162 lines (119 loc) · 4.03 KB

README.md

File metadata and controls

executable file
·
162 lines (119 loc) · 4.03 KB

Notify Icon

Notify

Phone notifications on your smart glasses

MentraOS Miniapp MIT License Version 1.1.0

Notify displays your phone notifications directly on your smart glasses. Stay informed at a glance without reaching for your phone.

Features

  • Instant Delivery — Notifications appear on your glasses within seconds
  • Smart Queuing — Multiple notifications display one at a time, in order
  • Auto-Dismiss — Each notification clears after 10 seconds
  • Duplicate Detection — Same notification won't show twice
  • Noise Filtering — Media apps (YouTube, Maps) are filtered out
  • Multi-Language — Supports 100+ locales with smart text wrapping

How It Works

Phone Notification → MentraOS Cloud → Notify → Smart Glasses
  1. A notification arrives on your phone
  2. MentraOS forwards it to the Notify service
  3. Notify formats and displays it on your glasses
  4. Notification auto-dismisses after 10 seconds

Display Format

Notifications appear as:

App Name - Title: Content

Example:

Slack - John Doe: Hey, are you free for a call?
  • Max length: 125 characters
  • Line width: 35 characters (auto-wrapped)
  • Display time: 10 seconds

Getting Started

Prerequisites

  • Bun runtime
  • MentraOS API key
  • Docker (optional, for containerized deployment)

Installation

# Clone the repository
git clone https://github.com/TeamOpenSmartGlasses/Notify.git
cd Notify

# Install dependencies
bun install

# Copy environment template
cp .env.example .env
# Edit .env with your API key

Development

# Run in development mode (with hot reload)
bun run dev

# Build for production
bun run build

# Start production server
bun run start

Docker

# Development
npm run docker:dev

# Production
npm run prod

# Stop containers
npm run docker:stop

Configuration

Environment Variables

Variable Description Default
AUGMENTOS_API_KEY Your MentraOS API key Required
CLOUD_HOST_NAME MentraOS cloud host prod.mentraglass.com
PACKAGE_NAME App package name com.augmentos.notify
PORT Server port 80

Project Structure

Notify/
├── src/
│   ├── index.ts              # Main server & NotificationManager
│   ├── public/
│   │   └── tpa_config.json   # TPA metadata
│   └── utils/
│       ├── languageLocale.ts # Language/locale mapping
│       └── text-wrapping/    # Text formatting utilities
├── docker/                   # Docker configurations
├── scripts/                  # Helper scripts
└── package.json

Tech Stack

  • Runtime: Bun
  • Framework: Express
  • SDK: @augmentos/sdk
  • Language: TypeScript
  • Deployment: Docker, Porter

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Links