Skip to main content

Actyx Reference

Supported OS and architectures#

PlatformSupported OSSupported architecture
WindowsWindows 10 or Windows Server 2019x86_64
AndroidAndroid 6-10x86, arm64-v8a or armeabi-v7a ABI
LinuxUbuntu 18.04+ or Alpine 3.9+x86_64, aarch64, armv7 or arm
DockerDocker 20+x86_64, aarch64, armv7 or arm
macOSBig Surx86_64 or aarch64
Android 11 not supported

Note that Actyx is currently not supported on Android 11. We are on it and will release support for the latest version of Android in one of the coming releases!

Networking Requirements#

DeviceLAN/WLAN
  • ports 4001, 4454, 4458 unused
  • Incoming/outgoing connections on ports 4001, 4454, 4458 allowed
  • All nodes connected to same LAN/WLAN
  • ports 4001, 4454, 4458 unblocked
  • UDP unicast connections allowed (mDNS protocol, port 5353, IPv4 224.0.0.251, IPv6 ff02::fb)
  • Client-isolation disabled

It is not supported to put firewalls between devices of the same swarm. Wherever possible, devices should be placed within one broadcast domain. Placing devices of the same swarm across different broadcast domains requires manually configuring initial peers and configuring communication between these broadcast domains accordingly.

Performance#

A lot of different factors play into performance of Actyx and your apps. Assuming a standard network setup, rugged tablets or other devices with relatively low computing power, and a standard factory use case, these are approximate limits:

TypePerformance
Latencybelow 200 ms, not guaranteed as dependent on several factors
No. of nodesmax. 100 nodes
Event data rate~1 event per node per 10 seconds

The following list shows the factors that influence performance. Please note that these are not requirements, but assumptions made for the above performance characteristics:

FactorAssumption
LAN setup and latencystandard / WiFi
App runtimesWebview (Node.js) and Docker
DevicesRugged tablets or other devices with relatively low computing power (e.g. Raspberry Pi 3)
Device CPU1-2 GHz, x86/arm architecture
Device RAM1-4 GB
Programming languageTypescript
Business logic complexityStandard factory use case, production data and machine data acquisition
Assumptions do not fit your use case?

The limits regarding performance and disk space described on this page are only true within the circumstances outlined above. If one of these factors changes, the limits for your solution might change. If you are looking for guidance on a specific use case, please refer to our conceptual guide or contact us.

Disk space requirements#

The required disk space depends on the size, number, and compressibility of the events that are emitted by apps built on Actyx. These are example calculations for factory apps, either with or without machine integrations, based on our project experience and for a 1-year time frame:

With machine integrationsWithout machine integrations
Number of nodes810
Number of events10,000,000580,000
Disk space needed65 MB30 MB

The events used for the above examples contained information on orders and their progress, or machine values (~10) read from a OPC UA interface.

tip

We are already working on the functionality to configure replication and lifespan of events. By configuring when events should be deleted or to which devices they should be replicated, you will be able to optimize for low disk space usage.

Node Settings Schema#

Which settings are available and which values they may have is defined in the so-called Actyx Node Setting Schema. The most recent version thereof is available for download at:

https://developer.actyx.com/schemas/node-settings.schema.json