diff --git a/docs/hardware/mobile/community-apps.mdx b/docs/hardware/mobile/community-apps.mdx new file mode 100644 index 0000000..d4e3608 --- /dev/null +++ b/docs/hardware/mobile/community-apps.mdx @@ -0,0 +1,34 @@ +--- +title: "Community Apps" +description: "Apps built by the community" +--- + +## Native iOS app by [eladekkal](https://github.com/eladdekel). + +To run it on your device, you can either install the app directly through the current TestFlight [here](https://testflight.apple.com/join/v8SyuzMT), or build from the source code files in Xcode on your Mac. + +### Instructions + +- [Install 01 software](/software/installation) on your machine + +- In Xcode, open the 'zerooone-app' project file in the project folder, change the Signing Team and Bundle Identifier, and build. + +### Using the App + +To use the app there are four features: + +1. The speak "Button" + +Made to emulate the button on the hardware models of 01, the big, yellow circle in the middle of the screen is what you hold when you want to speak to the model, and let go when you're finished speaking. + +2. The settings button + +Tapping the settings button will allow you to input your websocket address so that the app can properly connect to your computer. + +3. The reconnect button + +The arrow will be RED when the websocket connection is not live, and GREEN when it is. If you're making some changes you can easily reconnect by simply tapping the arrow button (or you can just start holding the speak button, too!). + +4. The terminal button + +The terminal button allows you to see all response text coming in from the server side of the 01. You can toggle it by tapping on the button, and each toggle clears the on-device cache of text. diff --git a/docs/hardware/mobile/android.mdx b/docs/hardware/mobile/development.mdx similarity index 88% rename from docs/hardware/mobile/android.mdx rename to docs/hardware/mobile/development.mdx index b23df69..4d4ca25 100644 --- a/docs/hardware/mobile/android.mdx +++ b/docs/hardware/mobile/development.mdx @@ -1,10 +1,8 @@ --- -title: "Android" -description: "Control 01 from your Android phone" +title: "Development" +description: "How to get your 01 mobile app" --- -Using your phone is a great way to control 01. There are multiple options available. - ## [React Native app](https://github.com/OpenInterpreter/01/tree/main/software/source/clients/mobile) Work in progress, we will continue to improve this application. diff --git a/docs/hardware/mobile/download.mdx b/docs/hardware/mobile/download.mdx new file mode 100644 index 0000000..88ad12f --- /dev/null +++ b/docs/hardware/mobile/download.mdx @@ -0,0 +1,6 @@ +--- +title: "Download" +description: "How to get your 01 mobile app" +--- + +Using your phone is a great way to control 01. There are multiple options available. diff --git a/docs/hardware/mobile/ios.mdx b/docs/hardware/mobile/ios.mdx deleted file mode 100644 index d1b4c84..0000000 --- a/docs/hardware/mobile/ios.mdx +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: "iOS" -description: "Control 01 from your iOS phone" ---- - -Using your phone is a great way to control 01. There are multiple options available. - -## [React Native app](https://github.com/OpenInterpreter/01/tree/main/software/source/clients/mobile) - -Work in progress, we will continue to improve this application. - -If you want to run it on your device, you will need to install [Expo Go](https://expo.dev/go) on your mobile device. - -### Setup Instructions - -- [Install 01 software](/software/installation) on your machine - -- Run the Expo server: - -```shell -cd software/source/clients/mobile/react-native -npm install # install dependencies -npx expo start # start local expo development server -``` - -This will produce a QR code that you can scan with Expo Go on your mobile device. - -Open **Expo Go** on your mobile device and select _Scan QR code_ to scan the QR code produced by the `npx expo start` command. - -- Run 01: - -```shell -cd software # cd into `software` -poetry run 01 --mobile # exposes QR code for 01 Light server -``` - -### Using the App - -In the 01 mobile app, select _Scan Code_ to scan the QR code produced by the `poetry run 01 --mobile` command. - -Press and hold the button to speak, release to make the request. To rescan the QR code, swipe left on the screen to go back. - -## [Native iOS app](https://github.com/OpenInterpreter/01/tree/main/software/source/clients/ios) by [eladekkal](https://github.com/eladdekel). - -A community contibution ❤️ - -To run it on your device, you can either install the app directly through the current TestFlight [here](https://testflight.apple.com/join/v8SyuzMT), or build from the source code files in Xcode on your Mac. - -### Instructions - -- [Install 01 software](/software/installation) on your machine - -- In Xcode, open the 'zerooone-app' project file in the project folder, change the Signing Team and Bundle Identifier, and build. - -### Using the App - -To use the app there are four features: - -1. The speak "Button" - -Made to emulate the button on the hardware models of 01, the big, yellow circle in the middle of the screen is what you hold when you want to speak to the model, and let go when you're finished speaking. - -2. The settings button - -Tapping the settings button will allow you to input your websocket address so that the app can properly connect to your computer. - -3. The reconnect button - -The arrow will be RED when the websocket connection is not live, and GREEN when it is. If you're making some changes you can easily reconnect by simply tapping the arrow button (or you can just start holding the speak button, too!). - -4. The terminal button - -The terminal button allows you to see all response text coming in from the server side of the 01. You can toggle it by tapping on the button, and each toggle clears the on-device cache of text. diff --git a/docs/mint.json b/docs/mint.json index 9a0ed82..42f1912 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -83,8 +83,9 @@ { "group": "Mobile", "pages": [ - "hardware/mobile/ios", - "hardware/mobile/android" + "hardware/mobile/download", + "hardware/mobile/development", + "hardware/mobile/community-apps" ] } ]