From 596e4e15a75e2648cdd23ac9bb11639ae95b7e97 Mon Sep 17 00:00:00 2001 From: Mike Bird Date: Thu, 11 Jul 2024 16:17:29 -0400 Subject: [PATCH] "Update mobile control documentation: React Native app and community iOS app" --- docs/hardware/mobile.mdx | 71 +++++++++++++++++++++++++++++++++++++--- 1 file changed, 67 insertions(+), 4 deletions(-) diff --git a/docs/hardware/mobile.mdx b/docs/hardware/mobile.mdx index e83bcf7..acf42a6 100644 --- a/docs/hardware/mobile.mdx +++ b/docs/hardware/mobile.mdx @@ -3,8 +3,71 @@ title: "iOS & Android" description: "Control 01 from your mobile phone" --- -1. our react-native WIP app, and mostly is similar to its README that explains how to use it with Expo, and - https://github.com/OpenInterpreter/01/tree/main/software/source/clients/mobile +Using your phone is a great way to control 01. There are multiple options available. -2. the community native iOS app by eladekkal. - https://github.com/OpenInterpreter/01/tree/main/software/source/clients/ios +## [React Native app](https://github.com/OpenInterpreter/01/tree/main/software/source/clients/mobile) (iOS & Android) + +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.