Draw objects and run programs in the ARENA using Python!
The ARENA Python library user guide and tutorials: ARENA Documentation: Python.
Install package using pip:
pip3 install arena-py
Run the hello.py
example:
cd examples
python hello.py
hello.py
from arena import *
scene = Scene(host="arena.andrew.cmu.edu", realm="realm", scene="example")
@scene.run_once
def make_box():
scene.add_object(Box())
scene.run_tasks()
The above is the simplest example of an ARENA Python program. This library sits above the ARENA pub/sub MQTT message protocol: JSON messages described in more detail at https://github.com/conix-center/ARENA-core which runs in a browser. That forms a layer, in turn, on top of A-Frame and THREE.js javascript libraries.
We are adding protection to the ARENA MQTT broker, eventually to host an ACL list to limit access to change your scenes. As a first step, we are requiring Python programs to supply authentication through a Google account.
If you have a web browser available, the ARENA library Arena(host="myhost.com")
will launch a web browser the first time
and ask you for an account to authenticate you with, before opening a client MQTT connection.
For headless environments, the ARENA library Arena(host="myhost.com")
will provide you with a url to cut and paste in a
browser anywhere, ask you for an account to authenticate you with, and show you a code you can enter on the command line,
before opening a client MQTT connection.
python3 -c "from arena import auth; auth.signout()"
python3 -c "from arena import auth; auth.permissions()"
Changelog can be found here.
- arena/: The ARENA Python library
- examples/: Canonical examples of ARENA functions from the documentation
- examples/legacy/: Deprecated demos for ARENA-py < 0.1.0
- examples/legacy/digital-twins/: Deprecated demo of digital twins of physical spaces for ARENA-py < 0.1.0
- system-tests/: Workouts and tests for ARENA-py
- tools/: Reusable tools for any ARENA scene