ActyxOS on Android

Install ActyxOS on Android

Edge device requirements

For a list of supported devices, please refer to Supported edge devices Your edge device must meet the following requirements to install ActyxOS on Android:

Running ActyxOS on Android with a fleet management service

For running ActyxOS on Android in production, most users set up a fleet management service like Workspace One. Please refer to our guide for Using Workspace One for more information.

Install ActyxOS on your edge device

ActyxOS on Android is publicly available in the Google Play store. Just open the Google Play store on your device, search for ActyxOS and install it.

After clicking on the ActyxOS icon on your home screen, ActyxOS starts. While ActyxOS is running, you can also see ActyxOS in your notifications overview.

If you do not have access to the Google Play store, please have a look at our guide in the Troubleshooting section.

Check the status of your node

In order to check on its status and interact with the node, you need to download the Actyx CLI (ax or ax.exe) from https://downloads.actyx.com and add it to your path (for detailed insallation instructions of the Actyx CLI, go here).

You can then check on your ActyxOS node:

ax nodes ls --local <DEVICE_IP>

You should see something like:

+---------------+--------------+---------+----------+---------+---------------+--------------+---------------------------+---------+
| NODE ID | DISPLAY NAME | STATE | SETTINGS | LICENSE | APPS DEPLOYED | APPS RUNNING | STARTED | VERSION |
+---------------+--------------+---------+----------+---------+---------------+--------------+---------------------------+---------+
| 192.168.2.107 | | running | invalid | invalid | 0 | 0 | 2020-03-25T09:32:07+00:00 | 1.0.0 |
+---------------+--------------+---------+----------+---------+---------------+--------------+---------------------------+---------+

Congratulations, you have successfully installed ActyxOS on Android! Please note that ActyxOS is not operational, as you did not configure it yet. If you want to find out more about configuring ActyxOS node, please check our guide about configuring nodes.

Where to go next

  • Quickstart is a tutorial about ActyxOS with ready-to-use apps and configurations.
  • Get started for a detailed guide on how ActyxOS on Android works.
  • Troubleshooting describes common problems, workarounds and how to get help and submit issues.
  • FAQs provides answers to frequently asked questions. ///

Get started with ActyxOS on Android

Starting and Stopping ActyxOS

After you click on the ActyxOS icon on your home screen, ActyxOS will start. In your notification overview you can also see whether ActyxOS is misconfigured or operational. If you want to stop ActyxOS on your node, you need to go the your device settings-->Apps-->ActyxOS and then Force Stop ActyxOS.

If you would like to know more about hot to configure nodes, please go to the section Configuring nodes in our guide on Node and App Settings

Node and App lifecycles

Depending on the lifecycle stage that your ActyxOS nodes or apps are in, your interaction with it might be limited to certain commands. Please check our guide on Node and App Lifecycles to find out more.

Automatic restart of ActyxOS

If ActyxOS was running on your Android device, it will automatically restart upon reboot.

Starting and Stopping Apps

Apart from starting and stopping apps via the Actyx CLI, you can click on their icons and close them in the app switcher just as with every other Android app.

Troubleshooting

Getting help and filing issues

If you want to get help or file issues, please write an e-mail to [email protected]

Installing ActyxOS without access to the Google Play store

For everyone who does not have access to the Google Play store, ActyxOS is also publicly available as an APK. You can download it from https://downloads.actyx.com/.

After you downloaded the APK, you can install it on your Android device via adb (If you don't have adb, check this installation guide).

Before you connect your edge device to your development machine, make sure that USB debugging is enabled in the developer options. When you connect both devices for the first time, a popup will appear on your edge device and ask you allow the connection. After you established a connection, run:

$ adb install actyxos.apk
axosandroid.apk: 1 file pushed. 24.7 MB/s (89486267 bytes in 3.456s)
pkg: /data/local/tmp/axosandroid.apk
Success

You should now see ActyxOS on Android on the home screen of your Android device. After clicking on the app, ActyxOS starts. While ActyxOS is running, you can also see ActyxOS in your notifications overview.

ActyxOS node not responding

First, check that you entered the right IP in the ax command. If you still cannot connect, the output of ax nodes ls returns one of the two possible reasons:

  • ActyxOS is not reachable. This means that ActyxOS is not running on your node. Please click on the ActyxOS icon on your home screen. If ActyxOS is running, you can see it in the notifications overview of your Android device.
  • Host is not reachable. This means that your development machine cannot connect to your node. Please check that your development machine and your node are in the same network, and your firewall(s) allows them to connect via port 4457.