Skip to main contentMentraOS SDK Reference
Welcome to the reference for the MentraOS SDK. This section provides detailed information about all classes, interfaces, types, and enums available in the @mentra/sdk package.
Overview
The MentraOS SDK is organized into several main components:
- Primary Classes: Core classes like
AppServer and AppSession that serve as the main entry points for app development
- Manager Classes: Component classes like
EventManager, LayoutManager, and SettingsManager that handle specific functionalities
- Enums: Enumeration types that define constants and options throughout the SDK
- Interfaces: Type definitions for configuration objects, events, layouts, settings, and messages
- Utilities: Helper functions and utility classes
How to Use This Reference
This reference is organized by component category. If you’re looking for:
- How to create an app server, see the AppServer
- Event handling functionality, see the
EventManager
- UI display capabilities, see the
LayoutManager
- Settings management, see the
SettingsManager
- Available event types, see the Event Types
- Layout options, see the Layout Types
- Setting types and interfaces, see the Setting Types
- Configuration interfaces, see the Config Types
- Webhook interfaces, see the Webhook Types
- Message interfaces, see the Message Types
- Token utilities, see the Token Utilities
- Resource management and utility functions, see the Utilities
For practical implementation examples, refer to our Quickstart Guide and Core Concepts sections.