/**
 * Any CSS included here will be global. The classic template
 * bundles Infima by default. Infima is a CSS framework designed to
 * work well for content-centric websites.
 */

/* You can override the default Infima variables here. */
:root {
  --ifm-color-primary: #2e8555;
  --ifm-color-primary-dark: #29784c;
  --ifm-color-primary-darker: #277148;
  --ifm-color-primary-darkest: #205d3b;
  --ifm-color-primary-light: #33925d;
  --ifm-color-primary-lighter: #359962;
  --ifm-color-primary-lightest: #3cad6e;
  --ifm-code-font-size: 95%;
  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
}

/* For readability concerns, you should choose a lighter palette in dark mode. */
[data-theme='dark'] {
  --ifm-color-primary: #25c2a0;
  --ifm-color-primary-dark: #21af90;
  --ifm-color-primary-darker: #1fa588;
  --ifm-color-primary-darkest: #1a8870;
  --ifm-color-primary-light: #29d5b0;
  --ifm-color-primary-lighter: #32d8b4;
  --ifm-color-primary-lightest: #4fddbf;
  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
}


/**
 * CSS files with the .module.css suffix will be treated as CSS modules
 * and scoped locally.
 */

.heroBanner {
  padding: 4rem 0;
  text-align: center;
  position: relative;
  overflow: hidden;
}

@media screen and (max-width: 996px) {
  .heroBanner {
    padding: 2rem;
  }
}

.buttons {
  display: flex;
  align-items: center;
  justify-content: center;
}


module.exports = {
  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};


// @ts-check
// `@type` JSDoc annotations allow editor autocompletion and type checking
// (when paired with `@ts-check`).
// There are various equivalent ways to declare your Docusaurus config.
// See: https://docusaurus.io/docs/api/docusaurus-config

import {themes as prismThemes} from 'prism-react-renderer';

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'Docs',
  tagline: 'Omi Documentation',
  favicon: 'images/favicon.ico',
  trailingSlash: false,

  plugins: [require.resolve('docusaurus-lunr-search')],

  // Set the production url of your site here
  url: 'https://docs.omi.me',
  // Set the /<baseUrl>/ pathname under which your site is served
  // For GitHub pages deployment, it is often '/<projectName>/'
  baseUrl: '/',

  // GitHub pages deployment config.
  // If you aren't using GitHub pages, you don't need these.
  organizationName: 'BasedHardware', // Usually your GitHub org/user name.
  projectName: 'Omi', // Usually your repo name.

  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'warn',

  // Even if you don't use internationalization, you can use this field to set
  // useful metadata like html lang. For example, if your site is Chinese, you
  // may want to replace "en" with "zh-Hans".
  i18n: {
    defaultLocale: 'en',
    locales: ['en'],
  },

  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: './sidebars.js',
        },
        theme: {
          customCss: './src/css/custom.css',
        },
      }),
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      image: 'images/logo.png',
      navbar: {
        logo: {
          alt: 'Omi Logo',
          src: 'images/logo.png',
          srcDark: "images/logowhite.png",
        },
        items: [
          {
            type: 'docSidebar',
            sidebarId: 'tutorialSidebar',
            position: 'left',
            label: 'Docs',
          },
          {
            href: 'https://github.com/BasedHardware/omi',
            label: 'GitHub',
            position: 'right',
          },
        ],
      },
      footer: {
        style: 'dark',
        links: [
          {
            title: 'Community',
            items: [
              {
                label: 'Discord',
                href: 'https://discord.gg/omi',
              },
              {
                label: 'X',
                href: 'https://x.com/omedotme',
              },
              {
                label: 'LinkedIn',
                href: 'https://www.linkedin.com/company/omi-ai/',
              },
              {
                label: 'Instagram',
                href: 'https://www.instagram.com/based_hardware/',
              },
              
            ],
          },
        ],
        copyright: `Omi built with ❤️`,
      },
      prism: {
        theme: prismThemes.github,
        darkTheme: prismThemes.dracula,
      },
    }),
};

export default config;


/**
 * Creating a sidebar enables you to:
 - create an ordered group of docs
 - render a sidebar for each doc of that group
 - provide next/previous navigation

 The sidebars can be generated from the filesystem, or explicitly defined here.

 Create as many sidebars as you want.
 */

// @ts-check

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
  // By default, Docusaurus generates a sidebar from the docs folder structure
  // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],

  // But you can create a sidebar manually

  tutorialSidebar: [
    {
      type: 'category',
      label: 'Get Started',
      collapsed: false,
      items: [
        'get_started/introduction',
        'get_started/Flash_device'
      ]
    },
    {
      type: 'category',
      label: 'Developer',
      items: [
        {
          type: 'category',
          label: 'Apps',
          items: [
            'developer/apps/Introduction',
            'developer/apps/PromptBased',
            'developer/apps/Integrations',
            'developer/apps/audiostreaming',
            'developer/apps/Import',
            'developer/apps/Submitting',
          ]
        },
       'developer/AppSetup',
        {
          type: 'category',
          label: 'Backend',
          items: [
            'developer/backend/Backend_Setup',
            'developer/backend/backend_deepdive',
            'developer/backend/StoringMemory',
            'developer/backend/transcription',
            'developer/backend/memory_embeddings',
            'developer/backend/postprocessing'
          ]
        },
        {
          type: 'category',
          label: 'Firmware',
          items: [
            'developer/Compile_firmware',
          ]
        },
             {
          type: 'category',
          label: 'SDK',
          items: [
             'developer/sdk/sdk',
            'developer/sdk/python',
             'developer/sdk/ReactNative',
           'developer/sdk/swift'
          ]
        },
        
        'developer/Protocol',
        'developer/Contribution',
        {
          type: 'category',
          label: 'Audio & Testing',
          items: [
            'developer/savingaudio',
            'developer/AudioStreaming',
            'developer/DevKit2Testing'
          ]
        },

      ]
    },
    {
      type: 'category',
      label: 'Hardware',
      items: [
        'hardware/DevKit1',
        'hardware/DevKit2',
        'hardware/OpenGlass'
      ]
    },
    {
      type: 'category',
      label: 'DIY Guide',
      items: [
        'assembly/introduction',
        'assembly/Buying_Guide',
        'assembly/Build_the_device'
      ]
    },
    {
      type: 'category',
      label: 'Info',
      items: [
        'info/Support',
        'info/License',
        'info/Disclaimer',
        'info/Privacy'
      ]
    }
  ],

};

export default sidebars;


import React, { useEffect } from 'react';
import { useHistory } from '@docusaurus/router';

function Home() {
  const history = useHistory();

  useEffect(() => {
    history.push('/docs/developer/apps/introduction');
  }, [history]);

  return null;
}

export default Home;


import React, { useEffect } from 'react';
import { useHistory } from '@docusaurus/router';

function Home() {
  const history = useHistory();

  useEffect(() => {
    history.push('/docs/get_started/introduction');
  }, [history]);

  return null;
}

export default Home;


Docs Contribution​

What is a significant contribution and what will be merged?​

Rewards

Paid Bounties

What if there are no paid bounties available?​

Bounty Rules​

We welcome contributions from the community! If you are interested in improving Omi, check out our  (Some of the tasks have paid bounties) To contribute:

Contribution

Docs

Introduction

To update the firmware of your OMI device, you can either:

Update OMI Firmware

Get started with omi device

Get started with omi

As a developer, you can create an app for Omi, letting other people to use your apps and earn.

Prompt-Based Apps

Integration apps allow OMI to interact with external services and process data in real-time. This guide will walk you through creating both Memory Creation Triggers and Real-Time Transcript Processors.

Developing Integration Apps for OMI

Real-Time Audio Streaming

Import Apps

To submit your app to the OMI community, go to [omi mobile app and submit](https://x.com/kodjima33/status/1854725658485965061) there.

Submitting Apps

Learn how to integrate your application with OMI using OAuth 2.0 to securely access user data.

OMI OAuth 2.0 Integration

Sending Notifications with OMI

Learn how to send notifications to OMI users from your applications, including direct text notifications and best practices for implementation.

Follow these steps to get started with your Omi. Don't want to bother with code? Use our official version on / store

App Setup

Welcome to the Omi backend setup guide! Omi is an innovative, multimodal AI assistant that combines cutting-edge technologies to provide a seamless user experience. This guide will help you set up the backend infrastructure that powers Omi's intelligent capabilities.

Backend Setup

Welcome to the Omi backend! This document provides a comprehensive overview of Omi's architecture and code, guiding you through its key components, functionalities, and how it all works together to power a unique and intelligent AI assistant experience.

Backend Deep Dive

This document outlines the process of storing memory objects in the Omi AI system.

Storing Memories

This document outlines the real-time audio transcription process in the Omi application.

Realtime Transcription

This document outlines how Omi creates and stores embeddings for memories.

Memory Embeddings

This document outlines the post-processing workflow for memories in the Omi application.

Memory Post-Processing

Step-by-step guide to compile and install firmware for your OMI device.

Compiling the Device Firmware

Python SDK

React Native SDK

Swift SDK

App-device protocol

A Model Context Protocol server for Omi interaction and automation. This server provides tools to read, search, and manipulate Memories and Conversations.

Model Context Protocol

Storing Audio

Dev Kit 2 Testing

DevKit 1 is a necklace form factor device that can be worn around the neck. It runs on Xiao nRF52840, is powered by a rechargeable battery, and connects to your phone to stream the audio data. The device is designed to be used with the Omi app, which is available on the Apple App Store and Google Play Store.

Omi DevKit 1

DevKit 2 builds on top of and expands the DevKit1 capabilities, while keeping the necklace form factor. It still runs on Xiao nRF52840, but adds 8GB onboard storage, and a speaker, and replaces the on/off switch with a programmable button. This enables the device to listen in standalone mode, although you still need to connect it to the Omi app for processing.

Omi DevKit 2

omiGlass DevKit

As an open-source community, we empower enthusiasts to create their own OMI devices. This guide focuses on building the **Developer Kit 1**, as the **Developer Kit 2** relies on a custom PCB and is not suited for DIY assembly.

Build Your Own OMI Device

Please note that availability and prices may vary by region.

Part List

Follow this step-by-step guide to build your own OMI device

Building the Device

For open-source support, please open an issue on GitHub and/or ask in our Discord Community. For commercial support, license inquiries, or any other questions, please contact us directly at [team@basedhardware.com](mailto:team@basedhardware.com)

Support

Omi is available under [MIT License](https://github.com/BasedHardware/omi/blob/main/LICENSE)

License

Please note that the Omi is a prototype project and is provided “as is”, without warranty of any kind. Use of the device should comply with all local laws and regulations concerning privacy and data protection.

Disclaimer

At Omi, your privacy and the security of your data are our top priorities. This Privacy Policy is designed to be transparent about how we collect, use, and protect your information.

Get Started

Developer

Hardware

DIY Guide

Info

​Docs Contribution​

​Rewards

​What is a significant contribution and what will be merged?​

​Paid Bounties

​Bounty Rules​

​What if there are no paid bounties available?​

Docs Contribution

Rewards

What is a significant contribution and what will be merged?

Paid Bounties

Bounty Rules

What if there are no paid bounties available?