Update README & Fix Keys
This commit is contained in:
parent
58ba20e705
commit
e19bb551ec
53
README.md
53
README.md
|
@ -1,41 +1,66 @@
|
||||||
## OpenGlass - Open Source Smart Glasses
|
# 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)
|
![IMG_7658](https://github.com/BasedHardware/openglass/assets/1193692/d42364e2-78f6-41ff-845f-dba2052b2f3c)
|
||||||
|
|
||||||
### Video demo
|
## Video demo
|
||||||
|
|
||||||
https://youtu.be/DsM_-c2e1ew
|
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.
|
We will ship a limited number of pre-built kits.
|
||||||
https://forms.gle/K1dtrn1mPrMBsQZC9
|
https://forms.gle/K1dtrn1mPrMBsQZC9
|
||||||
|
|
||||||
### Community (Setup questions, contribution guide, etc)
|
## Community (Setup questions, contribution guide, etc)
|
||||||
|
|
||||||
Join the [Based Hardware Discord](https://discord.com/invite/ZutWMTJnwA)
|
Join the [Based Hardware Discord](https://discord.com/invite/ZutWMTJnwA)
|
||||||
|
|
||||||
### Software
|
## Getting Started
|
||||||
1. Git clone and install with `npm install`
|
|
||||||
2. Run with `npm start`. Note this is an expo project, for now just open the localhost link to access the web version.
|
Follow these steps to set up OpenGlass:
|
||||||
|
|
||||||
### Hardware
|
### Hardware
|
||||||
|
|
||||||
1x Seeed Studio XIAO ESP32 S3 Sense - https://www.amazon.com/dp/B0C69FFVHH/ref=dp_iou_view_item?ie=UTF8&psc=1
|
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
|
||||||
|
|
||||||
1x EEMB LP502030 3.7v 250mAH battery - https://www.amazon.com/EEMB-Battery-Rechargeable-Lithium-Connector/dp/B08VRZTHDL
|
2. 3D print the glasses mount case using the provided STL file.
|
||||||
|
|
||||||
1x 3D printed glasses mount case - https://storage.googleapis.com/scott-misc/openglass_case.stl
|
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
|
||||||
|
|
||||||
<img width="923" alt="image" src="https://github.com/BasedHardware/openglass/assets/1193692/83a766bd-698b-4b4b-896a-834da286d69a">
|
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 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`.
|
||||||
|
|
||||||
### Getting started
|
5. Upload the firmware to the XIAO ESP32S3 board.
|
||||||
|
|
||||||
1. [Install firmware](https://github.com/BasedHardware/openglass/tree/main/firmware) on the Seeed Studio XIAO
|
|
||||||
|
|
||||||
2. 3D print your case
|
|
||||||
|
### Software
|
||||||
|
|
||||||
|
1. Clone the OpenGlass repository and install the dependencies:
|
||||||
|
```
|
||||||
|
git clone https://github.com/BasedHardware/openglass.git
|
||||||
|
cd openglass
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Add API keys for Grok, Ollama, and OpenAI in the `keys.ts` file located at https://github.com/BasedHardware/OpenGlass/blob/main/sources/keys.ts.
|
||||||
|
|
||||||
|
3. Start the application:
|
||||||
|
```
|
||||||
|
npm start
|
||||||
|
```
|
||||||
|
Note: This is an Expo project. For now, open the localhost link to access the web version.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
MIT
|
MIT
|
|
@ -1,5 +1,5 @@
|
||||||
export const keys = {
|
export const keys = {
|
||||||
grok: '',
|
grok: '',
|
||||||
ollana: '',
|
ollama: '',
|
||||||
openai: ''
|
openai: ''
|
||||||
};
|
};
|
|
@ -30,7 +30,7 @@ export async function ollamaInference(args: {
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
let resp = await axios.post(keys.ollana, {
|
let resp = await axios.post(keys.ollama, {
|
||||||
stream: false,
|
stream: false,
|
||||||
model: args.model,
|
model: args.model,
|
||||||
messages: converted,
|
messages: converted,
|
||||||
|
|
Loading…
Reference in New Issue