This is a tiny JavaScript library which provides a consistent API for fetching device info and sensor data from Pine64 PinePhone devices.
Various builds of pinephone.js are now provided. You can import the library in CommonJS or ES module format.
// CommonJS (Classic node.js)
const pinephone = require('pinephone')
// ES Module, import the entire library
import * as pinephone from 'pinephone'
// ES Module, import only what's needed (allows tree-shaking)
import { getModelName, getBluetoothStatus } from 'pinephone'If you just want to know if the device is an OG PinePhone or a Pro, use the following:
console.log( pinephone.getModelName() )
// output -> 'Pine64 PinePhone' OR 'Pine64 PinePhonePro'You can also get the version (helps to identify the phone's mainboard):
console.log( pinephone.getModelVersion() )
// output -> '1.0', '1.1', '1.2', etc...If you want these values returned as an object:
console.log( pinephone.getDeviceInfo() )
// output -> (example Object):
// {
// modelName: 'Pine64 PinePhonePro',
// modelVersion: '1.0'
// }If you want to hand-pick returned values, you can pass an array of constants like this (see full list of options):
console.log(pinephone.getDeviceInfo( [pinephone.Model_VersionNumber] ))
// output -> (example Object):
// {
// modelVersion: '1.0'
// }Find out if WiFi or Bluetooth are enabled, both at the software level and also the hardware level (via the kill switch located inside the back cover of the phone).
console.log( pinephone.getBluetoothStatus() )
// output -> (example Object):
// {
// softwareEnabled: false,
// hardwareEnabled: true
// }
console.log( pinephone.getWifiStatus() )
// output -> (example Object):
// {
// softwareEnabled: false,
// hardwareEnabled: false
// }This one is pretty self-explanitory. Just remember not to test disabling WiFi if you are connected to the phone via SSH!
pinephone.enableWifi();
pinephone.disableWifi();
pinephone.enableBluetooth();
pinephone.disableBluetooth();Sensor data is accessed via EventEmitter events. By default, sensors are sampled every 50ms.
Reading sensor data is currently not implemented in this version of pinephone.js, but the feature will be made available very soon.
See src/test-scripts/read-x-accel.mjs for example code if you are curious and want to implement something right away.
Bun is semi-supported. Getting basic device information works, and reading sensor data will also work once that is implemented, however anything involving rfkill under the hood will fail, such as reading and setting WiFi/Bluetooth states. This is because Bun hasn't implemented node's child_process API yet, and they likely won't until a clean solution is able to be implemented.
Until that happens, the only possible solutions I see are to manually implement what goes on in rfkill inside pinephone.js, which would be quite time-consuming. The other option would be to use a utility shim such as this, which allows for using exec. A fork of pinephone.js with this patch might be a good middle-ground.
There may also be a bug with Bun on arm64 devices. "bun install pinephone" seems to work only some of the time on my PinePhone Pro. Bun always reports that the install has completed, but many times the node_modules/pinephone/ folder gets created but is left empty.
The best way to contribute is by submitting issues and/or pull requests to the pinephone.js development repository. If you would like to contribute financially, a donation would be greatly appriciated (see next section).
This library was developed by a sole individual of the PinePhone community - I am not affiliated with Pine64, the company! Any donations you make here will go directly to me, not Pine64. If you are looking instead to support Pine64 (which I highly recommend, they're awesome), please consider purchasing one of their devices or donating to them.
That said, if you like pinephone.js or have found it to be a useful development tool, a donation would be greatly appriciated. Thank you!
Donate with fiat:
Donate with crypto:
- Monero (XMR): 4B12BmQuYNF9PHg275ASbfiD7iXy1vK2YJkxtK5V4xv9UTrxFv9ZQ4ASokykTvEVa7fL1NDbtKdLyEDHsMGrRht4FdHqiKj
- Litecoin (LTC): LLfE4awRw47ghQJzMvmn1WPvVykcXwqt9S
- Bitcoin Cash (BCH): qpzezt09wvry2tc30pzlsj9tk9npmu70kqht4x3xqg
Disclaimer: "PINE64 and the PINE64 pinecone logo are trademarked by Pine Store Limited." For more information, please visit this webpage. Please contact me if you have any issues or concerns involving this project's use of branding or imagery.