Skip to content

Commit

Permalink
Added structure to Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
akshaynarisetti committed May 12, 2024
1 parent 13c1d64 commit ac1b33d
Showing 1 changed file with 17 additions and 19 deletions.
36 changes: 17 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,20 @@
# OpenGlass - Open Source Smart Glasses

Turn any glasses into hackable smart glasses with less than $25 of off-the shelf components. Record your life, remember people you meet, identify objects, translate text, and more.
Turn any glasses into hackable smart glasses with less than $25 of off-the-shelf components. Record your life, remember people you meet, identify objects, translate text, and more.

![IMG_7658](https://github.com/BasedHardware/openglass/assets/1193692/d42364e2-78f6-41ff-845f-dba2052b2f3c)
![OpenGlass](https://github.com/BasedHardware/openglass/assets/1193692/d42364e2-78f6-41ff-845f-dba2052b2f3c)

## Video demo
## Video Demo

https://youtu.be/DsM_-c2e1ew
[![OpenGlass Demo](https://img.youtube.com/vi/DsM_-c2e1ew/0.jpg)](https://youtu.be/DsM_-c2e1ew)

## Want a pre-built version?
## Want a Pre-built Version?

We will ship a limited number of pre-built kits.
https://forms.gle/K1dtrn1mPrMBsQZC9
We will ship a limited number of pre-built kits. Fill out the [interest form](https://forms.gle/K1dtrn1mPrMBsQZC9) to get notified.

## Community (Setup questions, contribution guide, etc)
## Community

Join the [Based Hardware Discord](https://discord.com/invite/ZutWMTJnwA)
Join the [Based Hardware Discord](https://discord.com/invite/ZutWMTJnwA) for setup questions, contribution guide, and more.

## Getting Started

Expand All @@ -24,27 +23,25 @@ Follow these steps to set up OpenGlass:
### Hardware

1. Gather the required components:
- 1x Seeed Studio XIAO ESP32 S3 Sense - https://www.amazon.com/dp/B0C69FFVHH/ref=dp_iou_view_item?ie=UTF8&psc=1
- 1x EEMB LP502030 3.7v 250mAH battery - https://www.amazon.com/EEMB-Battery-Rechargeable-Lithium-Connector/dp/B08VRZTHDL
- 1x 3D printed glasses mount case - https://storage.googleapis.com/scott-misc/openglass_case.stl
- [Seeed Studio XIAO ESP32 S3 Sense](https://www.amazon.com/dp/B0C69FFVHH/ref=dp_iou_view_item?ie=UTF8&psc=1)
- [EEMB LP502030 3.7v 250mAH battery](https://www.amazon.com/EEMB-Battery-Rechargeable-Lithium-Connector/dp/B08VRZTHDL)
- [3D printed glasses mount case](https://storage.googleapis.com/scott-misc/openglass_case.stl)

2. 3D print the glasses mount case using the provided STL file.

3. Open the [firmware folder](https://github.com/BasedHardware/openglass/tree/main/firmware) and open the `.ino` file in the Arduino IDE.
- If you don't have the Arduino IDE installed, download and install it from the official website: https://www.arduino.cc/en/software
- If you don't have the Arduino IDE installed, download and install it from the [official website](https://www.arduino.cc/en/software).

4. Follow the software preparation steps to set up the Arduino IDE for the XIAO ESP32S3 board:
- Add ESP32 board package to your Arduino IDE:
- Navigate to File > Preferences, and fill "Additional Boards Manager URLs" with the URL: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
- Navigate to File > Preferences, and fill "Additional Boards Manager URLs" with the URL: `https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json`
- Navigate to Tools > Board > Boards Manager..., type the keyword `esp32` in the search box, select the latest version of `esp32`, and install it.
- Select your board and port:
- On top of the Arduino IDE, select the port (likely to be COM3 or higher).
- Search for `xiao` in the development board on the left and select `XIAO_ESP32S3`.

5. Upload the firmware to the XIAO ESP32S3 board.



### Software

1. Clone the OpenGlass repository and install the dependencies:
Expand All @@ -54,9 +51,9 @@ Follow these steps to set up OpenGlass:
npm install
```

2. Add API keys for groq and OpenAI in the `keys.ts` file located at https://github.com/BasedHardware/OpenGlass/blob/main/sources/keys.ts.
2. Add API keys for Groq and OpenAI in the `keys.ts` file located at [https://github.com/BasedHardware/OpenGlass/blob/main/sources/keys.ts](https://github.com/BasedHardware/OpenGlass/blob/main/sources/keys.ts).

3. For Ollama, self-host the REST API from the repository at https://github.com/ollama/ollama and add the URL to the `keys.ts` file.
3. For Ollama, self-host the REST API from the repository at [https://github.com/ollama/ollama](https://github.com/ollama/ollama) and add the URL to the `keys.ts` file.

4. Start the application:
```
Expand All @@ -65,4 +62,5 @@ Follow these steps to set up OpenGlass:
Note: This is an Expo project. For now, open the localhost link to access the web version.

## License
MIT

This project is licensed under the MIT License.

0 comments on commit ac1b33d

Please sign in to comment.