SDK

This is the SDK for PenumbraOS, the full development platform for the late Humane Ai Pin.

Caution

This is extremely experimental and currently is usable by developers only. See Installation for in-progress instructions on how to set it up.

Current functionality

The PenumbraOS SDK exposes the following restricted interfaces on the Ai Pin:

• HTTP - Custom API implementation. Hopefully will add OkHttp handler soon
• WebSocket - Custom API implementation. Hopefully will add OkHttp handler soon
• Touchpad
• Speech Recognition

Architecture

Due to the locked down nature of the Humane Ai Pin, actually achieving access to "privileged" operations is very convoluted (untrusted_app cannot even access the network). The PenumbraOS SDK is designed to mitigate the setup issues and make a repeatable solution suitable for end users. The general spawn capabilities are provided by the pinitd init system.

Embedded SDK

This is the actual exposed API surface to developers, run from within your untrusted_app. The SDK maintains the multiplexed connection to the bridge service, making a clean developer experience for the underlying callback-based Binder service. Located in /sdk.

Bridge Service

Quite literally just a bridge between the SDK and the privileged world. untrusted_app on the Pin is restricted to making binder connections to exclusively the nfc and radio SELinux domains. Since radio is everything having to do with cellular which is always in use, nfc becomes the obvious choice. pinitd is used to spawn a process as the nfc user and domain, and app_process is used to set up the JVM and run the actual service. Located in /bridge.

Bridge System Service

The gateway to all actual privileged operations. Currently, all operations are exclusively things that can run in the system domain, so bridge-system also runs in system. Communicates with bridge-core over Binder. Located in /bridge-system.

Installation

This is an active work in progress and may be difficult to set up. Please reach out to @agg23 for questions or help.

Note

These steps are chosen for active development of PenumbraOS and do not represent what the end user experience should be like. In a normal environment, pinitd is already running and the bridge and bridge-priv services are set to run on boot and automatically restart on error.

1. Run build.sh. This will build bridge_priv_rs, install it, copy pinitd service configs, then build + install the bridge and example Android projects.
2. Due to PenumbraOS/pinitd#4, starting apps may not work after setting up the pinitd environment. Start your primary app (the included example app, MABL, or your own custom app) now to ensure it runs (or use the included mabl.unit service to autostart it). You can wait for the BRIDGE_SERVICE_READY broadcast for when you can start talking to the bridge service.
3. Start pinitd. At the time of writing this is accomplished by running:

/data/local/tmp/bin/pinitd-cli debug-manual-start

but this will change in the future.

4. Enable the required services:

/data/local/tmp/bin/pinitd-cli enable bridge-service
/data/local/tmp/bin/pinitd-cli enable bridge-system-service
/data/local/tmp/bin/pinitd-cli enable mabl

5. Once pinitd is running and the services are enabled, you can start the bridge services. bridge-service depends on everything else (including MABL), so it will automatically launch all services as necessary on startup.

/data/local/tmp/bin/pinitd-cli start bridge-service
sleep 5
/data/local/tmp/bin/pinitd-cli start bridge-system-service

6. At this point, everything should be operational and the custom app should be able to talk to the PenumbraOS SDK. To avoid the app starting issue, you can use the "Apply changes" button in Android Studio to update your app without relaunching.