docs • getting started • android

Running on Android

Using the Termux app makes it easy to run Node-RED on Android devices. Get it directly from their github or via F-Droid here Termux on F-Droid.

Note that the Play Store version is not maintained.

Note : the Node-RED team have no connection with the Termux application nor its development, nor F-Droid. We cannot provide support for it in any way, other than to say that at this point in time it works.

Installing

Install it, and run it. Then at the prompt type

apt update
apt upgrade
apt install coreutils nano nodejs
npm i -g --unsafe-perm node-red
node-red

Then you can point a browser to http://localhost:1880

Note that installing openssh may make interacting with termux a little easier. see this thread for a description of one such install.

Notes

You can also npm install other node-red nodes such as node-red-dashboard in the standard way :
```
cd ~/.node-red
npm i node-red-dashboard
```
or via the Pallete Manager.
The volume-down key is the ctrl key - so vol-down-c can be used to “break” a running app.
The instructions above also install the nano editor, which is useful for editing files.

Autostarting

The recommended way of starting applications running in Termux is using the Termux:Boot application (available from F-droid - note that the Play Store version may not be maintained, and it’s recommended to use the same source that you installed termux from).

We have found this other app useful for autostarting Termux on boot - Autostart - No Root (Note: with termux:boot, use of other autoboot apps does not seem to be required).

Note that the shebang in the node-red script is incompatible with termux:boot scripts. The workaround is to start node-red using a termux:boot startup script like:

#!/data/data/com.termux/files/usr/bin/sh
termux-wake-lock
node /data/data/com.termux/files/usr/bin/node-red

Device Access

You can get direct access to various hardware on the device by using the extra Termux device plugins - which can then be accessed via Node-RED using the exec node.

Note: you need to install both the add-on app, and also the add-on api in Termux.

Install add-on app - Termux:API from the same source you got termux.

Install add-on access into Termux

apt install termux-api

Useful links

Node-RED: Low-code programming for event-driven applications.

Copyright OpenJS Foundation and Node-RED contributors. All rights reserved. The OpenJS Foundation has registered trademarks and uses trademarks. For a list of trademarks of the OpenJS Foundation, please see our Trademark Policy and Trademark List. Trademarks and logos not indicated on the list of OpenJS Foundation trademarks are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.