diff --git a/content/python-api/arena.md b/content/python-api/arena.md index 5994f060..d91a4770 100644 --- a/content/python-api/arena.md +++ b/content/python-api/arena.md @@ -3,7 +3,7 @@ title: Python API has_children: true nav_order: 6.5 --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/arena_mqtt.md b/content/python-api/arena_mqtt.md index 766411a9..781b45a5 100644 --- a/content/python-api/arena_mqtt.md +++ b/content/python-api/arena_mqtt.md @@ -3,7 +3,7 @@ title: arena.arena_mqtt parent: Python API has_children: true --- -arena-py API v1.0.2 +arena-py API v1.1.0
@@ -32,7 +32,7 @@ has_children: true
- ArenaMQTT( web_host='arenaxr.org', realm='realm', network_latency_interval=10000, on_msg_callback=None, end_program_callback=None, video=False, debug=False, headless=False, **kwargs) + ArenaMQTT( web_host='arenaxr.org', realm='realm', network_latency_interval=10000, on_msg_callback=None, end_program_callback=None, video=False, debug=False, headless=False, environment=False, **kwargs)
@@ -285,7 +285,7 @@ has_children: true
-

Returns a random 6 digit id

+

Returns a random 6 digit id.

@@ -300,7 +300,7 @@ has_children: true
-

Update client latency in $NETWORK/latency

+

Update client latency in $NETWORK/latency.

@@ -315,7 +315,7 @@ has_children: true
-

Runs a user-defined function on startup

+

Runs a user-defined function on startup.

@@ -330,7 +330,7 @@ has_children: true
-

Runs a user-defined function after a interval_ms milliseconds

+

Runs a user-defined function after a interval_ms milliseconds.

@@ -345,7 +345,7 @@ has_children: true
-

Runs a user defined aynscio function

+

Runs a user defined aynscio function.

@@ -360,7 +360,7 @@ has_children: true
-

Runs a function every interval_ms milliseconds

+

Runs a function every interval_ms milliseconds.

@@ -375,7 +375,7 @@ has_children: true
-

Run event loop

+

Run event loop.

@@ -390,7 +390,7 @@ has_children: true
-

Stop event loop

+

Stop event loop.

@@ -405,7 +405,7 @@ has_children: true
-

Public function for sleeping in async functions

+

Public function for sleeping in async functions.

@@ -420,7 +420,7 @@ has_children: true
-

Paho MQTT client on_connect callback

+

Paho MQTT client on_connect callback.

@@ -500,7 +500,7 @@ has_children: true
-

Paho MQTT client on_disconnect callback

+

Paho MQTT client on_disconnect callback.

@@ -515,7 +515,7 @@ has_children: true
-

Disconnects Paho MQTT client

+

Disconnects Paho MQTT client.

@@ -530,7 +530,7 @@ has_children: true
-

Subscribes to new topic and adds callback

+

Subscribes to new topic and adds callback.

@@ -545,7 +545,7 @@ has_children: true
-

Unsubscribes to topic and removes callback

+

Unsubscribes to topic and removes callback.

@@ -560,7 +560,7 @@ has_children: true
-

Return receive queue length

+

Return receive queue length.

@@ -575,7 +575,7 @@ has_children: true
-

Return publish queue length

+

Return publish queue length.

@@ -590,7 +590,7 @@ has_children: true
-

Return client id

+

Return client id.

diff --git a/content/python-api/attributes.md b/content/python-api/attributes.md index 5f5a74db..f3ab0cba 100644 --- a/content/python-api/attributes.md +++ b/content/python-api/attributes.md @@ -3,7 +3,7 @@ title: arena.attributes parent: Python API has_children: true --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/animation.md b/content/python-api/attributes/animation.md index 81102201..fb95b04f 100644 --- a/content/python-api/attributes/animation.md +++ b/content/python-api/attributes/animation.md @@ -3,7 +3,7 @@ title: arena.attributes.animation parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/animation_mixer.md b/content/python-api/attributes/animation_mixer.md index f6076538..d552c0c0 100644 --- a/content/python-api/attributes/animation_mixer.md +++ b/content/python-api/attributes/animation_mixer.md @@ -3,7 +3,7 @@ title: arena.attributes.animation_mixer parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/armarker.md b/content/python-api/attributes/armarker.md index a6529b2c..fdefe348 100644 --- a/content/python-api/attributes/armarker.md +++ b/content/python-api/attributes/armarker.md @@ -3,7 +3,7 @@ title: arena.attributes.armarker parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/attribute.md b/content/python-api/attributes/attribute.md index 91b752e6..40302100 100644 --- a/content/python-api/attributes/attribute.md +++ b/content/python-api/attributes/attribute.md @@ -3,7 +3,7 @@ title: arena.attributes.attribute parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/attribution.md b/content/python-api/attributes/attribution.md index c03982f7..be5b3d36 100644 --- a/content/python-api/attributes/attribution.md +++ b/content/python-api/attributes/attribution.md @@ -3,7 +3,7 @@ title: arena.attributes.attribution parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/blip.md b/content/python-api/attributes/blip.md index 84b9179f..bbd56dcf 100644 --- a/content/python-api/attributes/blip.md +++ b/content/python-api/attributes/blip.md @@ -3,7 +3,7 @@ title: arena.attributes.blip parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/box_collision_listener.md b/content/python-api/attributes/box_collision_listener.md index 117aeebf..41bf1c04 100644 --- a/content/python-api/attributes/box_collision_listener.md +++ b/content/python-api/attributes/box_collision_listener.md @@ -3,7 +3,7 @@ title: arena.attributes.box_collision_listener parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/click_listener.md b/content/python-api/attributes/click_listener.md index 373dc14d..99a03b6f 100644 --- a/content/python-api/attributes/click_listener.md +++ b/content/python-api/attributes/click_listener.md @@ -3,7 +3,7 @@ title: arena.attributes.click_listener parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/color.md b/content/python-api/attributes/color.md index b045187f..2521cfe4 100644 --- a/content/python-api/attributes/color.md +++ b/content/python-api/attributes/color.md @@ -3,7 +3,7 @@ title: arena.attributes.color parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/data.md b/content/python-api/attributes/data.md index 6d06f841..135750db 100644 --- a/content/python-api/attributes/data.md +++ b/content/python-api/attributes/data.md @@ -3,7 +3,7 @@ title: arena.attributes.data parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/data_event.md b/content/python-api/attributes/data_event.md index dc84a95e..76be4978 100644 --- a/content/python-api/attributes/data_event.md +++ b/content/python-api/attributes/data_event.md @@ -3,7 +3,7 @@ title: arena.attributes.data_event parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/dynamic_body.md b/content/python-api/attributes/dynamic_body.md index b7c3a872..763ce40d 100644 --- a/content/python-api/attributes/dynamic_body.md +++ b/content/python-api/attributes/dynamic_body.md @@ -3,7 +3,7 @@ title: arena.attributes.dynamic_body parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/gltf_model_lod.md b/content/python-api/attributes/gltf_model_lod.md index 100bea3a..d5253480 100644 --- a/content/python-api/attributes/gltf_model_lod.md +++ b/content/python-api/attributes/gltf_model_lod.md @@ -3,7 +3,7 @@ title: arena.attributes.gltf_model_lod parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/gltf_morph.md b/content/python-api/attributes/gltf_morph.md index a8006e12..5806f2eb 100644 --- a/content/python-api/attributes/gltf_morph.md +++ b/content/python-api/attributes/gltf_morph.md @@ -3,7 +3,7 @@ title: arena.attributes.gltf_morph parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/goto_landmark.md b/content/python-api/attributes/goto_landmark.md index 2ec25eca..541b99c4 100644 --- a/content/python-api/attributes/goto_landmark.md +++ b/content/python-api/attributes/goto_landmark.md @@ -3,7 +3,7 @@ title: arena.attributes.goto_landmark parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/goto_url.md b/content/python-api/attributes/goto_url.md index 278f5533..a2218993 100644 --- a/content/python-api/attributes/goto_url.md +++ b/content/python-api/attributes/goto_url.md @@ -3,7 +3,7 @@ title: arena.attributes.goto_url parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/impulse.md b/content/python-api/attributes/impulse.md index e5e60f01..0edbc9cf 100644 --- a/content/python-api/attributes/impulse.md +++ b/content/python-api/attributes/impulse.md @@ -3,7 +3,7 @@ title: arena.attributes.impulse parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/jitsi_video.md b/content/python-api/attributes/jitsi_video.md index a262ec35..ed746722 100644 --- a/content/python-api/attributes/jitsi_video.md +++ b/content/python-api/attributes/jitsi_video.md @@ -3,7 +3,7 @@ title: arena.attributes.jitsi_video parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/landmark.md b/content/python-api/attributes/landmark.md index 2ea76167..b7ccb89a 100644 --- a/content/python-api/attributes/landmark.md +++ b/content/python-api/attributes/landmark.md @@ -3,7 +3,7 @@ title: arena.attributes.landmark parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/material.md b/content/python-api/attributes/material.md index 09c84c8b..65619a4c 100644 --- a/content/python-api/attributes/material.md +++ b/content/python-api/attributes/material.md @@ -3,7 +3,7 @@ title: arena.attributes.material parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/material_extras.md b/content/python-api/attributes/material_extras.md index 8d175dd1..b3007a03 100644 --- a/content/python-api/attributes/material_extras.md +++ b/content/python-api/attributes/material_extras.md @@ -3,7 +3,7 @@ title: arena.attributes.material_extras parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/model_update.md b/content/python-api/attributes/model_update.md index d8bd6eca..1047bf94 100644 --- a/content/python-api/attributes/model_update.md +++ b/content/python-api/attributes/model_update.md @@ -3,7 +3,7 @@ title: arena.attributes.model_update parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/multisrc.md b/content/python-api/attributes/multisrc.md index f9e695de..0761c22e 100644 --- a/content/python-api/attributes/multisrc.md +++ b/content/python-api/attributes/multisrc.md @@ -3,7 +3,7 @@ title: arena.attributes.multisrc parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/position.md b/content/python-api/attributes/position.md index 86f798f2..7dc7a384 100644 --- a/content/python-api/attributes/position.md +++ b/content/python-api/attributes/position.md @@ -3,7 +3,7 @@ title: arena.attributes.position parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/remote_render.md b/content/python-api/attributes/remote_render.md index 4a3e013c..a655c14f 100644 --- a/content/python-api/attributes/remote_render.md +++ b/content/python-api/attributes/remote_render.md @@ -3,7 +3,7 @@ title: arena.attributes.remote_render parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/rotation.md b/content/python-api/attributes/rotation.md index 75df2388..70c0fa3c 100644 --- a/content/python-api/attributes/rotation.md +++ b/content/python-api/attributes/rotation.md @@ -3,7 +3,7 @@ title: arena.attributes.rotation parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/scale.md b/content/python-api/attributes/scale.md index 0ef618e7..625717ed 100644 --- a/content/python-api/attributes/scale.md +++ b/content/python-api/attributes/scale.md @@ -3,7 +3,7 @@ title: arena.attributes.scale parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/shadow.md b/content/python-api/attributes/shadow.md index 26b8eda8..55fd2b60 100644 --- a/content/python-api/attributes/shadow.md +++ b/content/python-api/attributes/shadow.md @@ -3,7 +3,7 @@ title: arena.attributes.shadow parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/sound.md b/content/python-api/attributes/sound.md index a36dab9f..6063b9a0 100644 --- a/content/python-api/attributes/sound.md +++ b/content/python-api/attributes/sound.md @@ -3,7 +3,7 @@ title: arena.attributes.sound parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/spe_particles.md b/content/python-api/attributes/spe_particles.md index f55b1e8e..1115b458 100644 --- a/content/python-api/attributes/spe_particles.md +++ b/content/python-api/attributes/spe_particles.md @@ -3,7 +3,7 @@ title: arena.attributes.spe_particles parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/static_body.md b/content/python-api/attributes/static_body.md index 0529e5ef..391f4fa1 100644 --- a/content/python-api/attributes/static_body.md +++ b/content/python-api/attributes/static_body.md @@ -3,7 +3,7 @@ title: arena.attributes.static_body parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/textinput.md b/content/python-api/attributes/textinput.md index e8241ca3..8b9374c9 100644 --- a/content/python-api/attributes/textinput.md +++ b/content/python-api/attributes/textinput.md @@ -3,7 +3,7 @@ title: arena.attributes.textinput parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/translate.md b/content/python-api/attributes/translate.md index a9457bd8..80177fa0 100644 --- a/content/python-api/attributes/translate.md +++ b/content/python-api/attributes/translate.md @@ -3,7 +3,7 @@ title: arena.attributes.translate parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/attributes/video_control.md b/content/python-api/attributes/video_control.md index 85df365d..78a6cdcf 100644 --- a/content/python-api/attributes/video_control.md +++ b/content/python-api/attributes/video_control.md @@ -3,7 +3,7 @@ title: arena.attributes.video_control parent: arena.attributes grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/auth.md b/content/python-api/auth.md index 0ea67f24..b7667efb 100644 --- a/content/python-api/auth.md +++ b/content/python-api/auth.md @@ -3,7 +3,7 @@ title: arena.auth parent: Python API has_children: true --- -arena-py API v1.0.2 +arena-py API v1.1.0
@@ -61,7 +61,7 @@ needed, getting username and state from ARENA server.

def - authenticate_scene(self, web_host, realm, scene, username, video=False): + authenticate_scene(self, web_host, realm, scene, username, video=False, env=False):
@@ -175,6 +175,36 @@ or admin, for now, get a fresh mqtt_token each time.

+
+
+
+ + def + upload_store_file(self, web_host, scenename, src_file_path, dest_file_path=None): + + +
+ + +

Upload a source file to the user's file store space. Google authentication is required.

+ +
Parameters
+ +
    +
  • str web_host: The hostname of the ARENA webserver.
  • +
  • str scenename: The scene name/id.
  • +
  • str src_file_path: Local path to the file to upload (required).
  • +
  • str dest_file_path: Destination file path, can include dirs. Defaults to filename from src_file_path (optional).
  • +
+ +
Returns
+ +
+

Url address of successful file upload location, or None if failed.

+
+
+ +
@@ -215,7 +245,7 @@ or admin, for now, get a fresh mqtt_token each time.

def - urlopen(self, url, data=None, creds=False, csrf=None): + urlopen(self, url, data=None, headers=None, creds=False, csrf=None):
diff --git a/content/python-api/base_object.md b/content/python-api/base_object.md index eac29b05..f521da4d 100644 --- a/content/python-api/base_object.md +++ b/content/python-api/base_object.md @@ -3,7 +3,7 @@ title: arena.base_object parent: Python API has_children: true --- -arena-py API v1.0.2 +arena-py API v1.1.0
diff --git a/content/python-api/device.md b/content/python-api/device.md index 8c7282e4..f16a446a 100644 --- a/content/python-api/device.md +++ b/content/python-api/device.md @@ -3,7 +3,7 @@ title: arena.device parent: Python API has_children: true --- -arena-py API v1.0.2 +arena-py API v1.1.0
@@ -35,10 +35,10 @@ Can create and execute various user-defined functions/tasks.

  • str realm: Reserved topic fork for future use (optional).
  • str namespace: Username of authenticated user or other namespace (automatic).
  • str device: The name of the device, without namespace (required).
  • -
  • int network_latency_interval: Interval (in ms) to run network graph latency update. Default value is 10000 (10 secs). Ignore this parameter.
  • -
  • func on_msg_callback: Called on all MQTT messages received. Default = None.
  • -
  • func end_program_callback: Called on MQTT disconnect. Default = None.
  • -
  • bool debug: If true, print a log of all publish messages from this client. Default = False.
  • +
  • int network_latency_interval: Interval (in ms) to run network graph latency update. Default value is 10000 (10 secs). Ignore this parameter (optional).
  • +
  • func on_msg_callback: Called on all MQTT messages received (optional).
  • +
  • func end_program_callback: Called on MQTT disconnect (optional).
  • +
  • bool debug: If true, print a log of all publish messages from this client (optional).
  • diff --git a/content/python-api/env.md b/content/python-api/env.md index f043bdba..7455a927 100644 --- a/content/python-api/env.md +++ b/content/python-api/env.md @@ -3,7 +3,7 @@ title: arena.env parent: Python API has_children: true --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -118,8 +118,8 @@ If undefined, will try to use local authentication information previously saved.

    .. envvar:: MQTTH

    The :envvar:MQTTH defines the MQTT host used by the library. -This variable allows to use a broker different from the host argument passed to the -scene constructor

    +This variable allows to use a broker different from the host argument passed to the +scene constructor.

    @@ -135,7 +135,7 @@ scene constructor

    .. envvar:: DEVICE

    -

    The :envvar:DEVICE defines the name of a device, to publish and listen to. +

    The :envvar:DEVICE defines the name of a device, to publish and listen to. After connecting, the library listens to device topic as follows: {REALM}/d/{NAMESPACE}/{SCENE}.

    @@ -173,7 +173,7 @@ This is passed by the runtime and used to identify the program object that repre

    .. envvar:: ENABLE_INTERPRETER

    The :envvar:ENABLE_INTERPRETER enables the a simple command line interpreter that -can be used to inspect library/program state. Set this variable with a value of +can be used to inspect library/program state. Set this variable with a value of true, 1 or t (case insensitive) to enable the interpreter.

    Default: 'false'

    @@ -192,8 +192,8 @@ can be used to inspect library/program state. Set this variable with a value of

    .. envvar:: ARENA_TELEMETRY

    -

    The :envvar:ARENA_TELEMETRY environment variable enables the library's telemetry to generate -traces, metrics, and logs. Set this variable with a value of otlp, mqtt or console (case insensitive) +

    The :envvar:ARENA_TELEMETRY environment variable enables the library's telemetry to generate +traces, metrics, and logs. Set this variable with a value of otlp, mqtt or console (case insensitive) to enable telemetry using OpenTelemetry (OTEL) and its Protocol (OTLP), send JSON OTEL spans to MQTT, or to the console.

    @@ -210,7 +210,7 @@ to enable telemetry using OpenTelemetry (OTEL) and its Protocol (OTLP), send JSO

    .. envvar:: OTLP_ENDPOINT

    -

    The :envvar:OTLP_ENDPOINT environment variable is used when OTLP telemetry is enabled (ARENA_TELEMETRY=otlp) to define +

    The :envvar:OTLP_ENDPOINT environment variable is used when OTLP telemetry is enabled (ARENA_TELEMETRY=otlp) to define the telemtry endpoint.

    Our implementation uses OpenTelemetry (OTEL) and its Protocol (OTLP) for encoding and transport.

    @@ -231,8 +231,8 @@ the telemtry endpoint.

    .. envvar:: OTEL_LOG_LEVEL

    -

    The :envvar:OTEL_LOG_LEVEL environment variable sets the log level used by the logger -implementation (ArenaTelemetry) using OpenTelemetry (OTEL). +

    The :envvar:OTEL_LOG_LEVEL environment variable sets the log level used by the logger +implementation (ArenaTelemetry) using OpenTelemetry (OTEL). Default: "info".

    @@ -250,7 +250,7 @@ Default: "info".

    .. envvar:: PROGRAM_STATS_UPDATE_INTERVAL_MS

    The :envvar:PROGRAM_STATS_UPDATE_INTERVAL_MS environment variable defines how often program -stats are published

    +stats are published.

    Default: 5000.

    diff --git a/content/python-api/event_loop.md b/content/python-api/event_loop.md index 4b0d8694..4537d395 100644 --- a/content/python-api/event_loop.md +++ b/content/python-api/event_loop.md @@ -3,7 +3,7 @@ title: arena.event_loop parent: Python API has_children: true --- -arena-py API v1.0.2 +arena-py API v1.1.0
    diff --git a/content/python-api/event_loop/async_worker.md b/content/python-api/event_loop/async_worker.md index c162cc38..46a6bcb4 100644 --- a/content/python-api/event_loop/async_worker.md +++ b/content/python-api/event_loop/async_worker.md @@ -3,7 +3,7 @@ title: arena.event_loop.async_worker parent: arena.event_loop grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    diff --git a/content/python-api/event_loop/asyncio_mqtt.md b/content/python-api/event_loop/asyncio_mqtt.md index a57a2543..88f4f78a 100644 --- a/content/python-api/event_loop/asyncio_mqtt.md +++ b/content/python-api/event_loop/asyncio_mqtt.md @@ -3,7 +3,7 @@ title: arena.event_loop.asyncio_mqtt parent: arena.event_loop grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    diff --git a/content/python-api/event_loop/event_loop.md b/content/python-api/event_loop/event_loop.md index 2a65c2e2..fbf069bc 100644 --- a/content/python-api/event_loop/event_loop.md +++ b/content/python-api/event_loop/event_loop.md @@ -3,7 +3,7 @@ title: arena.event_loop.event_loop parent: arena.event_loop grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    diff --git a/content/python-api/event_loop/lazy_worker.md b/content/python-api/event_loop/lazy_worker.md index 81580a15..41ce6ca0 100644 --- a/content/python-api/event_loop/lazy_worker.md +++ b/content/python-api/event_loop/lazy_worker.md @@ -3,7 +3,7 @@ title: arena.event_loop.lazy_worker parent: arena.event_loop grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    diff --git a/content/python-api/event_loop/persistent_worker.md b/content/python-api/event_loop/persistent_worker.md index 4d3fd228..0778c0f6 100644 --- a/content/python-api/event_loop/persistent_worker.md +++ b/content/python-api/event_loop/persistent_worker.md @@ -3,7 +3,7 @@ title: arena.event_loop.persistent_worker parent: arena.event_loop grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    diff --git a/content/python-api/event_loop/single_worker.md b/content/python-api/event_loop/single_worker.md index 073a90d1..35331fd4 100644 --- a/content/python-api/event_loop/single_worker.md +++ b/content/python-api/event_loop/single_worker.md @@ -3,7 +3,7 @@ title: arena.event_loop.single_worker parent: arena.event_loop grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    diff --git a/content/python-api/event_loop/worker.md b/content/python-api/event_loop/worker.md index f01918e6..691a17c6 100644 --- a/content/python-api/event_loop/worker.md +++ b/content/python-api/event_loop/worker.md @@ -3,7 +3,7 @@ title: arena.event_loop.worker parent: arena.event_loop grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    diff --git a/content/python-api/events.md b/content/python-api/events.md index 8070aa6b..4a062beb 100644 --- a/content/python-api/events.md +++ b/content/python-api/events.md @@ -3,7 +3,7 @@ title: arena.events parent: Python API has_children: true --- -arena-py API v1.0.2 +arena-py API v1.1.0
    diff --git a/content/python-api/events/event.md b/content/python-api/events/event.md index 1c38742e..8146cc16 100644 --- a/content/python-api/events/event.md +++ b/content/python-api/events/event.md @@ -3,7 +3,7 @@ title: arena.events.event parent: arena.events grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -40,6 +40,19 @@ grand_parent: Python API +
    +
    +
    + + def + json(self, **kwargs): + + +
    + + + +
    Inherited Members
    @@ -47,7 +60,6 @@ grand_parent: Python API diff --git a/content/python-api/objects.md b/content/python-api/objects.md index dd4c29c4..cf86a9cb 100644 --- a/content/python-api/objects.md +++ b/content/python-api/objects.md @@ -3,7 +3,7 @@ title: arena.objects parent: Python API has_children: true --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -19,7 +19,7 @@ has_children: true
    OBJECT_TYPE_MAP = - {'entity': <class 'arena.objects.entity.Entity'>, 'arenaui-button-panel': <class 'arena.objects.arenaui_button_panel.ArenauiButtonPanel'>, 'arenaui-card': <class 'arena.objects.arenaui_card.ArenauiCard'>, 'arenaui-prompt': <class 'arena.objects.arenaui_prompt.ArenauiPrompt'>, 'box': <class 'arena.objects.box.Box'>, 'camera': <class 'arena.objects.camera.Camera'>, 'capsule': <class 'arena.objects.capsule.Capsule'>, 'circle': <class 'arena.objects.circle.Circle'>, 'cone': <class 'arena.objects.cone.Cone'>, 'cube': <class 'arena.objects.cube.Cube'>, 'cylinder': <class 'arena.objects.cylinder.Cylinder'>, 'dodecahedron': <class 'arena.objects.dodecahedron.Dodecahedron'>, 'gaussian_splatting': <class 'arena.objects.gaussian_splatting.GaussianSplatting'>, 'gltf-model': <class 'arena.objects.gltf_model.GltfModel'>, 'handLeft': <class 'arena.objects.hand_left.HandLeft'>, 'handRight': <class 'arena.objects.hand_right.HandRight'>, 'icosahedron': <class 'arena.objects.icosahedron.Icosahedron'>, 'image': <class 'arena.objects.image.Image'>, 'light': <class 'arena.objects.light.Light'>, 'line': <class 'arena.objects.line.Line'>, 'obj-model': <class 'arena.objects.obj_model.ObjModel'>, 'ocean': <class 'arena.objects.ocean.Ocean'>, 'octahedron': <class 'arena.objects.octahedron.Octahedron'>, 'pcd-model': <class 'arena.objects.pcd_model.PcdModel'>, 'plane': <class 'arena.objects.plane.Plane'>, 'ring': <class 'arena.objects.ring.Ring'>, 'roundedbox': <class 'arena.objects.roundedbox.Roundedbox'>, 'sphere': <class 'arena.objects.sphere.Sphere'>, 'tetrahedron': <class 'arena.objects.tetrahedron.Tetrahedron'>, 'text': <class 'arena.objects.text.Text'>, 'thickline': <class 'arena.objects.thickline.Thickline'>, 'threejs-scene': <class 'arena.objects.threejs_scene.ThreejsScene'>, 'torus': <class 'arena.objects.torus.Torus'>, 'torusKnot': <class 'arena.objects.torus_knot.TorusKnot'>, 'triangle': <class 'arena.objects.triangle.Triangle'>, 'urdf-model': <class 'arena.objects.urdf_model.UrdfModel'>, 'videosphere': <class 'arena.objects.videosphere.Videosphere'>} + {'entity': <class 'arena.objects.entity.Entity'>, 'arenaui-button-panel': <class 'arena.objects.arenaui_button_panel.ArenauiButtonPanel'>, 'arenaui-card': <class 'arena.objects.arenaui_card.ArenauiCard'>, 'arenaui-prompt': <class 'arena.objects.arenaui_prompt.ArenauiPrompt'>, 'box': <class 'arena.objects.box.Box'>, 'camera': <class 'arena.objects.camera.Camera'>, 'capsule': <class 'arena.objects.capsule.Capsule'>, 'circle': <class 'arena.objects.circle.Circle'>, 'cone': <class 'arena.objects.cone.Cone'>, 'cube': <class 'arena.objects.cube.Cube'>, 'cylinder': <class 'arena.objects.cylinder.Cylinder'>, 'dodecahedron': <class 'arena.objects.dodecahedron.Dodecahedron'>, 'gaussian_splatting': <class 'arena.objects.gaussian_splatting.GaussianSplatting'>, 'gltf-model': <class 'arena.objects.gltf_model.GltfModel'>, 'handLeft': <class 'arena.objects.hand_left.HandLeft'>, 'handRight': <class 'arena.objects.hand_right.HandRight'>, 'icosahedron': <class 'arena.objects.icosahedron.Icosahedron'>, 'image': <class 'arena.objects.image.Image'>, 'light': <class 'arena.objects.light.Light'>, 'line': <class 'arena.objects.line.Line'>, 'obj-model': <class 'arena.objects.obj_model.ObjModel'>, 'ocean': <class 'arena.objects.ocean.Ocean'>, 'octahedron': <class 'arena.objects.octahedron.Octahedron'>, 'pcd-model': <class 'arena.objects.pcd_model.PcdModel'>, 'plane': <class 'arena.objects.plane.Plane'>, 'ring': <class 'arena.objects.ring.Ring'>, 'roundedbox': <class 'arena.objects.roundedbox.Roundedbox'>, 'sphere': <class 'arena.objects.sphere.Sphere'>, 'tetrahedron': <class 'arena.objects.tetrahedron.Tetrahedron'>, 'text': <class 'arena.objects.text.Text'>, 'thickline': <class 'arena.objects.thickline.Thickline'>, 'threejs-scene': <class 'arena.objects.threejs_scene.ThreejsScene'>, 'torus': <class 'arena.objects.torus.Torus'>, 'torusKnot': <class 'arena.objects.torus_knot.TorusKnot'>, 'triangle': <class 'arena.objects.triangle.Triangle'>, 'program': <class 'arena.objects.program.Program'>, 'urdf-model': <class 'arena.objects.urdf_model.UrdfModel'>, 'videosphere': <class 'arena.objects.videosphere.Videosphere'>}
    diff --git a/content/python-api/objects/arena_object.md b/content/python-api/objects/arena_object.md index 3acd3a7d..a88a5197 100644 --- a/content/python-api/objects/arena_object.md +++ b/content/python-api/objects/arena_object.md @@ -3,7 +3,7 @@ title: arena.objects.arena_object parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -76,6 +76,18 @@ grand_parent: Python API +
    +
    +
    + private_objects = +{} + + +
    + + + +
    @@ -250,6 +262,20 @@ grand_parent: Python API +
    +
    +
    +
    @classmethod
    + + def + add_private(cls, obj): + + +
    + + + +
    diff --git a/content/python-api/objects/arenaui_button_panel.md b/content/python-api/objects/arenaui_button_panel.md index 1122c8f8..f345e3d1 100644 --- a/content/python-api/objects/arenaui_button_panel.md +++ b/content/python-api/objects/arenaui_button_panel.md @@ -3,7 +3,7 @@ title: arena.objects.arenaui_button_panel parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -83,6 +83,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -96,6 +97,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    @@ -133,6 +135,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -146,6 +149,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/arenaui_card.md b/content/python-api/objects/arenaui_card.md index d7c7d90f..aba32856 100644 --- a/content/python-api/objects/arenaui_card.md +++ b/content/python-api/objects/arenaui_card.md @@ -3,7 +3,7 @@ title: arena.objects.arenaui_card parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -78,6 +78,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -92,6 +93,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    @@ -128,6 +130,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -142,6 +145,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/arenaui_prompt.md b/content/python-api/objects/arenaui_prompt.md index 9b15d0fd..3a547114 100644 --- a/content/python-api/objects/arenaui_prompt.md +++ b/content/python-api/objects/arenaui_prompt.md @@ -3,7 +3,7 @@ title: arena.objects.arenaui_prompt parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -71,6 +71,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -85,6 +86,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    @@ -121,6 +123,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -135,6 +138,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/box.md b/content/python-api/objects/box.md index c2616a97..b5e01afc 100644 --- a/content/python-api/objects/box.md +++ b/content/python-api/objects/box.md @@ -3,7 +3,7 @@ title: arena.objects.box parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -70,6 +70,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -84,6 +85,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/camera.md b/content/python-api/objects/camera.md index e345d171..f0a8fa03 100644 --- a/content/python-api/objects/camera.md +++ b/content/python-api/objects/camera.md @@ -3,7 +3,7 @@ title: arena.objects.camera parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -153,6 +153,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -167,6 +168,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/capsule.md b/content/python-api/objects/capsule.md index 0b9f4273..1d3889d4 100644 --- a/content/python-api/objects/capsule.md +++ b/content/python-api/objects/capsule.md @@ -3,7 +3,7 @@ title: arena.objects.capsule parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -68,6 +68,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -82,6 +83,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/circle.md b/content/python-api/objects/circle.md index 52cd45b8..fb280253 100644 --- a/content/python-api/objects/circle.md +++ b/content/python-api/objects/circle.md @@ -3,7 +3,7 @@ title: arena.objects.circle parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -68,6 +68,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -82,6 +83,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/cone.md b/content/python-api/objects/cone.md index b1b4e507..9095e9a2 100644 --- a/content/python-api/objects/cone.md +++ b/content/python-api/objects/cone.md @@ -3,7 +3,7 @@ title: arena.objects.cone parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -72,6 +72,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -86,6 +87,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/cube.md b/content/python-api/objects/cube.md index bb71eea7..2cf3b863 100644 --- a/content/python-api/objects/cube.md +++ b/content/python-api/objects/cube.md @@ -3,7 +3,7 @@ title: arena.objects.cube parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -71,6 +71,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -85,6 +86,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/cylinder.md b/content/python-api/objects/cylinder.md index 4c947c67..76df31ec 100644 --- a/content/python-api/objects/cylinder.md +++ b/content/python-api/objects/cylinder.md @@ -3,7 +3,7 @@ title: arena.objects.cylinder parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -71,6 +71,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -85,6 +86,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/dodecahedron.md b/content/python-api/objects/dodecahedron.md index 1d9095bc..1db89fb3 100644 --- a/content/python-api/objects/dodecahedron.md +++ b/content/python-api/objects/dodecahedron.md @@ -3,7 +3,7 @@ title: arena.objects.dodecahedron parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -66,6 +66,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -80,6 +81,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/entity.md b/content/python-api/objects/entity.md index 19c6cbe5..feeca4ab 100644 --- a/content/python-api/objects/entity.md +++ b/content/python-api/objects/entity.md @@ -3,7 +3,7 @@ title: arena.objects.entity parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -66,6 +66,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -80,6 +81,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/gaussian_splatting.md b/content/python-api/objects/gaussian_splatting.md index 746c42db..da10a361 100644 --- a/content/python-api/objects/gaussian_splatting.md +++ b/content/python-api/objects/gaussian_splatting.md @@ -3,7 +3,7 @@ title: arena.objects.gaussian_splatting parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -68,6 +68,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -82,6 +83,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/gltf_model.md b/content/python-api/objects/gltf_model.md index 65cc027f..bb732906 100644 --- a/content/python-api/objects/gltf_model.md +++ b/content/python-api/objects/gltf_model.md @@ -3,7 +3,7 @@ title: arena.objects.gltf_model parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -141,6 +141,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -153,6 +154,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    @@ -195,6 +197,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -207,6 +210,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    @@ -249,6 +253,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -261,6 +266,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/hand_left.md b/content/python-api/objects/hand_left.md index 2c53e19d..55cc5dfd 100644 --- a/content/python-api/objects/hand_left.md +++ b/content/python-api/objects/hand_left.md @@ -3,7 +3,7 @@ title: arena.objects.hand_left parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -77,6 +77,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -91,6 +92,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/hand_right.md b/content/python-api/objects/hand_right.md index 193fa0b4..d35a28c9 100644 --- a/content/python-api/objects/hand_right.md +++ b/content/python-api/objects/hand_right.md @@ -3,7 +3,7 @@ title: arena.objects.hand_right parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -77,6 +77,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -91,6 +92,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/icosahedron.md b/content/python-api/objects/icosahedron.md index d560229b..831b3710 100644 --- a/content/python-api/objects/icosahedron.md +++ b/content/python-api/objects/icosahedron.md @@ -3,7 +3,7 @@ title: arena.objects.icosahedron parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -66,6 +66,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -80,6 +81,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/image.md b/content/python-api/objects/image.md index fff59759..bf3df1f6 100644 --- a/content/python-api/objects/image.md +++ b/content/python-api/objects/image.md @@ -3,7 +3,7 @@ title: arena.objects.image parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -69,6 +69,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -83,6 +84,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/light.md b/content/python-api/objects/light.md index 098f1b8a..f32e44c3 100644 --- a/content/python-api/objects/light.md +++ b/content/python-api/objects/light.md @@ -3,7 +3,7 @@ title: arena.objects.light parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -99,6 +99,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -113,6 +114,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/line.md b/content/python-api/objects/line.md index de100585..a5bd242b 100644 --- a/content/python-api/objects/line.md +++ b/content/python-api/objects/line.md @@ -3,7 +3,7 @@ title: arena.objects.line parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -69,6 +69,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -83,6 +84,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/obj_model.md b/content/python-api/objects/obj_model.md index 65460133..f20ee89a 100644 --- a/content/python-api/objects/obj_model.md +++ b/content/python-api/objects/obj_model.md @@ -3,7 +3,7 @@ title: arena.objects.obj_model parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -66,6 +66,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -80,6 +81,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/ocean.md b/content/python-api/objects/ocean.md index 218e1fd6..0951d165 100644 --- a/content/python-api/objects/ocean.md +++ b/content/python-api/objects/ocean.md @@ -3,7 +3,7 @@ title: arena.objects.ocean parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -73,6 +73,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -87,6 +88,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/octahedron.md b/content/python-api/objects/octahedron.md index 54c1ed87..a4d5a4ec 100644 --- a/content/python-api/objects/octahedron.md +++ b/content/python-api/objects/octahedron.md @@ -3,7 +3,7 @@ title: arena.objects.octahedron parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -66,6 +66,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -80,6 +81,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/pcd_model.md b/content/python-api/objects/pcd_model.md index 0db6b0c6..7eb0ace7 100644 --- a/content/python-api/objects/pcd_model.md +++ b/content/python-api/objects/pcd_model.md @@ -3,7 +3,7 @@ title: arena.objects.pcd_model parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -68,6 +68,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -82,6 +83,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/plane.md b/content/python-api/objects/plane.md index 3ad4877c..27197636 100644 --- a/content/python-api/objects/plane.md +++ b/content/python-api/objects/plane.md @@ -3,7 +3,7 @@ title: arena.objects.plane parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -68,6 +68,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -82,6 +83,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/program.md b/content/python-api/objects/program.md index 1f855aea..7dffdfb2 100644 --- a/content/python-api/objects/program.md +++ b/content/python-api/objects/program.md @@ -3,7 +3,7 @@ title: arena.objects.program parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -45,7 +45,7 @@ grand_parent: Python API
    - Program( object_id='47050bfc-6f84-4afc-a896-ad8841acf32a', persist=False, objects_list_add=True, **kwargs) + Program( object_id='556c6691-f51e-4492-a05e-61e396c72e39', persist=False, objects_list_add=True, **kwargs)
    diff --git a/content/python-api/objects/ring.md b/content/python-api/objects/ring.md index 7071d082..448b3a30 100644 --- a/content/python-api/objects/ring.md +++ b/content/python-api/objects/ring.md @@ -3,7 +3,7 @@ title: arena.objects.ring parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -70,6 +70,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -84,6 +85,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/roundedbox.md b/content/python-api/objects/roundedbox.md index 2defa8b4..cd266a51 100644 --- a/content/python-api/objects/roundedbox.md +++ b/content/python-api/objects/roundedbox.md @@ -3,7 +3,7 @@ title: arena.objects.roundedbox parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -69,6 +69,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -83,6 +84,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/sphere.md b/content/python-api/objects/sphere.md index 30902145..0702d44e 100644 --- a/content/python-api/objects/sphere.md +++ b/content/python-api/objects/sphere.md @@ -3,7 +3,7 @@ title: arena.objects.sphere parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -71,6 +71,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -85,6 +86,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/tetrahedron.md b/content/python-api/objects/tetrahedron.md index d662b782..b66963c2 100644 --- a/content/python-api/objects/tetrahedron.md +++ b/content/python-api/objects/tetrahedron.md @@ -3,7 +3,7 @@ title: arena.objects.tetrahedron parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -66,6 +66,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -80,6 +81,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/text.md b/content/python-api/objects/text.md index cbc8bc30..90a38536 100644 --- a/content/python-api/objects/text.md +++ b/content/python-api/objects/text.md @@ -3,7 +3,7 @@ title: arena.objects.text parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -98,6 +98,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -112,6 +113,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/thickline.md b/content/python-api/objects/thickline.md index 3d30ec3e..74ecc3f7 100644 --- a/content/python-api/objects/thickline.md +++ b/content/python-api/objects/thickline.md @@ -3,7 +3,7 @@ title: arena.objects.thickline parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -68,6 +68,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -82,6 +83,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    @@ -118,6 +120,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -132,6 +135,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/threejs_scene.md b/content/python-api/objects/threejs_scene.md index 96d3d6d0..64662772 100644 --- a/content/python-api/objects/threejs_scene.md +++ b/content/python-api/objects/threejs_scene.md @@ -3,7 +3,7 @@ title: arena.objects.threejs_scene parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -65,6 +65,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -79,6 +80,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/torus.md b/content/python-api/objects/torus.md index 95f947a0..c5fa0bb6 100644 --- a/content/python-api/objects/torus.md +++ b/content/python-api/objects/torus.md @@ -3,7 +3,7 @@ title: arena.objects.torus parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -69,6 +69,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -83,6 +84,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/torus_knot.md b/content/python-api/objects/torus_knot.md index ebf14705..df8a0137 100644 --- a/content/python-api/objects/torus_knot.md +++ b/content/python-api/objects/torus_knot.md @@ -3,7 +3,7 @@ title: arena.objects.torus_knot parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -70,6 +70,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -84,6 +85,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/triangle.md b/content/python-api/objects/triangle.md index 68a65b76..09c1605b 100644 --- a/content/python-api/objects/triangle.md +++ b/content/python-api/objects/triangle.md @@ -3,7 +3,7 @@ title: arena.objects.triangle parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -67,6 +67,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -81,6 +82,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/urdf_model.md b/content/python-api/objects/urdf_model.md index d402e28c..1f398dba 100644 --- a/content/python-api/objects/urdf_model.md +++ b/content/python-api/objects/urdf_model.md @@ -3,7 +3,7 @@ title: arena.objects.urdf_model parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -67,6 +67,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -81,6 +82,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/objects/videosphere.md b/content/python-api/objects/videosphere.md index 10542790..61053f7a 100644 --- a/content/python-api/objects/videosphere.md +++ b/content/python-api/objects/videosphere.md @@ -3,7 +3,7 @@ title: arena.objects.videosphere parent: arena.objects grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -71,6 +71,7 @@ grand_parent: Python API
    arena.objects.arena_object.Object
    type
    all_objects
    +
    private_objects
    evt_handler
    update_handler
    animations
    @@ -85,6 +86,7 @@ grand_parent: Python API
    json
    get
    add
    +
    add_private
    remove
    exists
    diff --git a/content/python-api/scene.md b/content/python-api/scene.md index 7389c17b..6773779a 100644 --- a/content/python-api/scene.md +++ b/content/python-api/scene.md @@ -3,7 +3,7 @@ title: arena.scene parent: Python API has_children: true --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -35,17 +35,17 @@ Can create and execute various user-defined functions/tasks.

  • str realm: Reserved topic fork for future use (optional).
  • str namespace: Username of authenticated user or other namespace (automatic).
  • str scene: The name of the scene, without namespace (required).
  • -
  • int network_latency_interval: Interval (in ms) to run network graph latency update. Default value is 10000 (10 secs). Ignore this parameter.
  • -
  • func on_msg_callback: Called on all MQTT messages received. Default = None.
  • -
  • func new_obj_callback: Called on object 'create' MQTT messages received. Default = None.
  • -
  • func user_join_callback: Called on user id 'new' MQTT messages received. Default = None.
  • -
  • func user_left_callback: Called on user id 'leave' MQTT messages received. Default = None.
  • -
  • func delete_obj_callback: Called on object 'delete' MQTT messages received. Default = None.
  • -
  • func end_program_callback: Called on MQTT disconnect. Default = None.
  • -
  • bool video: If true, request permissions for video conference. Default = False.
  • -
  • bool debug: If true, print a log of all publish messages from this client. Default = False.
  • -
  • bool cli_args: If true, require CLI standardized parameters. Default = False.
  • -
  • bool headless: If true, force limited input device auth flow. Default = False.
  • +
  • int network_latency_interval: Interval (in ms) to run network graph latency update. Default value is 10000 (10 secs). Ignore this parameter (optional).
  • +
  • func on_msg_callback: Called on all MQTT messages received (optional).
  • +
  • func new_obj_callback: Called on object 'create' MQTT messages received (optional).
  • +
  • func user_join_callback: Called on user id 'new' MQTT messages received (optional).
  • +
  • func user_left_callback: Called on user id 'leave' MQTT messages received (optional).
  • +
  • func delete_obj_callback: Called on object 'delete' MQTT messages received (optional).
  • +
  • func end_program_callback: Called on MQTT disconnect (optional).
  • +
  • bool video: If true, request permissions for video conference (optional).
  • +
  • bool debug: If true, print a log of all publish messages from this client (optional).
  • +
  • bool cli_args: If true, require CLI standardized parameters (optional).
  • +
  • bool headless: If true, force limited input device auth flow (optional).
  • @@ -120,7 +120,7 @@ Can create and execute various user-defined functions/tasks.

    -

    Custom exit to push errors to telemetry

    +

    Custom exit to push errors to telemetry.

    @@ -135,7 +135,7 @@ Can create and execute various user-defined functions/tasks.

    -

    Paho MQTT client on_connect callback

    +

    Paho MQTT client on_connect callback.

    @@ -202,7 +202,7 @@ Can create and execute various user-defined functions/tasks.

    -

    Checks for number of arguments for callback

    +

    Checks for number of arguments for callback.

    @@ -217,7 +217,7 @@ Can create and execute various user-defined functions/tasks.

    -

    Publishes an custom event. Could be user or library defined

    +

    Publishes an custom event. Could be user or library defined.

    @@ -232,7 +232,7 @@ Can create and execute various user-defined functions/tasks.

    -

    Publishes an click event

    +

    Publishes an click event.

    @@ -247,7 +247,7 @@ Can create and execute various user-defined functions/tasks.

    -

    Publishes a camera manipulation event

    +

    Publishes a camera manipulation event.

    @@ -262,7 +262,7 @@ Can create and execute various user-defined functions/tasks.

    -

    Publishes a camera manipulation event

    +

    Publishes a camera manipulation event.

    @@ -277,7 +277,7 @@ Can create and execute various user-defined functions/tasks.

    -

    Publishes a camera manipulation event

    +

    Publishes a camera manipulation event.

    @@ -290,7 +290,37 @@ Can create and execute various user-defined functions/tasks.

    -

    Returns all the objects in a scene

    +

    Returns all the objects in a scene.

    +
    + + +
    +
    +
    + + def + get_private_objects(self, userid=None): + + +
    + + +

    Returns all private user objects.

    +
    + + +
    +
    +
    + + def + reset_private_objects(self, userid): + + +
    + + +

    Resets all private user objects.

    @@ -305,7 +335,7 @@ Can create and execute various user-defined functions/tasks.

    -

    Public function to create an object

    +

    Public function to create an object.

    @@ -320,7 +350,7 @@ Can create and execute various user-defined functions/tasks.

    -

    Public function to create multiple objects in a list

    +

    Public function to create multiple objects in a list.

    @@ -335,7 +365,7 @@ Can create and execute various user-defined functions/tasks.

    -

    Public function to update an object

    +

    Public function to update an object.

    @@ -350,7 +380,7 @@ Can create and execute various user-defined functions/tasks.

    -

    Public function to update multiple objects in a list

    +

    Public function to update multiple objects in a list.

    @@ -365,10 +395,38 @@ Can create and execute various user-defined functions/tasks.

    -

    Public function to delete an object

    +

    Public function to delete an object.

    +
    + + +
    +
    +
    + + def + delete_user_objects(self, userid): + + +
    + + +

    Deletes any private user objects.

    +
    +
    +
    + + def + delete_program(self, obj): + + +
    + + + +
    @@ -380,7 +438,7 @@ Can create and execute various user-defined functions/tasks.

    -

    Public function to delete a list of 'attributes' as a string[], updating each to null

    +

    Public function to delete a list of 'attributes' as a string[], updating each to null.

    @@ -395,7 +453,7 @@ Can create and execute various user-defined functions/tasks.

    -

    Runs all dispatched animations

    +

    Runs all dispatched animations.

    @@ -416,14 +474,14 @@ duration. Uses async sleep to avoid blocking.

    Parameters
      -
    • obj: arena object to update
    • -
    • anim: Animation to run
    • +
    • obj: arena object to update.
    • +
    • anim: Animation to run.
    Returns
    -

    created async task

    +

    created async task.

    @@ -441,7 +499,7 @@ duration. Uses async sleep to avoid blocking.

    Returns a dictionary for a persisted object.

    -

    If object is known by arena-py, return local object, not persisted

    +

    If object is known by arena-py, return local object, not persisted.

    @@ -458,9 +516,9 @@ duration. Uses async sleep to avoid blocking.

    Returns a dictionary of persisted objects.

    -

    If object is known by arena-py, return our local object, not persisted -Silently fails/skip objects without object_id and object_type (except programs) -Instantiates generic Object if object_type is given but unknown to arena-py

    +

    If object is known by arena-py, return our local object, not persisted. +Silently fails/skip objects without object_id and object_type (except programs). +Instantiates generic Object if object_type is given but unknown to arena-py.

    @@ -475,7 +533,7 @@ Instantiates generic Object if object_type is given but unknown to arena-py

    -

    Returns a dictionary for scene-options. [TODO] wrap the output as a BaseObject

    +

    Returns a dictionary for scene-options.

    @@ -490,8 +548,9 @@ Instantiates generic Object if object_type is given but unknown to arena-py

    -

    Request list of scene names for logged in user account that user has publish permission for. -Returns: list of scenes.

    +

    Request list of scene names for logged in user account that user has publish permission for.

    + +

    :returns list: list of scenes.

    @@ -506,7 +565,7 @@ Returns: list of scenes.

    -

    Returns a list of users

    +

    Returns a list of users.

    @@ -521,7 +580,7 @@ Returns: list of scenes.

    -

    Return QueueStats object with receive and publish queue length

    +

    Return QueueStats object with receive and publish queue length.

    @@ -536,7 +595,35 @@ Returns: list of scenes.

    -

    Callback when program stats are updated; publish program object update

    +

    Callback when program stats are updated; publish program object update.

    +
    + + +
    +
    +
    + + def + upload_store_file(self, src_file_path, dest_file_path=None): + + +
    + + +

    Upload a file to the filestore using the user's Google account.

    + +
    Parameters
    + +
      +
    • str src_file_path: Local path to the file to upload (required).
    • +
    • str dest_file_path: Destination file path, can include dirs. Defaults to filename from src_file_path (optional).
    • +
    + +
    Returns
    + +
    +

    Url address of successful file upload location, or None if failed.

    +
    @@ -625,11 +712,15 @@ Returns: list of scenes.

    look_at
    teleport_to_landmark
    all_objects
    +
    get_private_objects
    +
    reset_private_objects
    add_object
    add_objects
    update_object
    update_objects
    delete_object
    +
    delete_user_objects
    +
    delete_program
    delete_attributes
    run_animations
    create_delayed_task
    @@ -640,6 +731,7 @@ Returns: list of scenes.

    get_user_list
    get_rcv_pub_queue_len
    run_info_update
    +
    upload_store_file
    arena.arena_mqtt.ArenaMQTT
    diff --git a/content/python-api/scripts.md b/content/python-api/scripts.md index d533521c..970076cd 100644 --- a/content/python-api/scripts.md +++ b/content/python-api/scripts.md @@ -3,7 +3,7 @@ title: arena.scripts parent: Python API has_children: true --- -arena-py API v1.0.2 +arena-py API v1.1.0
    diff --git a/content/python-api/scripts/arena_py_permissions.md b/content/python-api/scripts/arena_py_permissions.md index 40b5ef24..cbf86940 100644 --- a/content/python-api/scripts/arena_py_permissions.md +++ b/content/python-api/scripts/arena_py_permissions.md @@ -3,7 +3,7 @@ title: arena.scripts.arena_py_permissions parent: arena.scripts grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    diff --git a/content/python-api/scripts/arena_py_pub.md b/content/python-api/scripts/arena_py_pub.md index 808d0077..574d7904 100644 --- a/content/python-api/scripts/arena_py_pub.md +++ b/content/python-api/scripts/arena_py_pub.md @@ -3,7 +3,7 @@ title: arena.scripts.arena_py_pub parent: arena.scripts grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    diff --git a/content/python-api/scripts/arena_py_signout.md b/content/python-api/scripts/arena_py_signout.md index c8fe83ab..6bc95367 100644 --- a/content/python-api/scripts/arena_py_signout.md +++ b/content/python-api/scripts/arena_py_signout.md @@ -3,7 +3,7 @@ title: arena.scripts.arena_py_signout parent: arena.scripts grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    diff --git a/content/python-api/scripts/arena_py_sub.md b/content/python-api/scripts/arena_py_sub.md index 40957396..e2b71562 100644 --- a/content/python-api/scripts/arena_py_sub.md +++ b/content/python-api/scripts/arena_py_sub.md @@ -3,7 +3,7 @@ title: arena.scripts.arena_py_sub parent: arena.scripts grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    diff --git a/content/python-api/scripts/arena_py_token.md b/content/python-api/scripts/arena_py_token.md index 444eca72..3e471725 100644 --- a/content/python-api/scripts/arena_py_token.md +++ b/content/python-api/scripts/arena_py_token.md @@ -3,7 +3,7 @@ title: arena.scripts.arena_py_token parent: arena.scripts grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    diff --git a/content/python-api/topics.md b/content/python-api/topics.md index 29a68adc..d248f442 100644 --- a/content/python-api/topics.md +++ b/content/python-api/topics.md @@ -3,7 +3,7 @@ title: arena.topics parent: Python API has_children: true --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -69,7 +69,7 @@ has_children: true
    SUBSCRIBE_TOPICS = - namespace(NETWORK='$NETWORK', DEVICE=<string.Template object>, PROC_REG=<string.Template object>, PROC_CTL=<string.Template object>, PROC_DBG=<string.Template object>, SCENE_PUBLIC=<string.Template object>, SCENE_PUBLIC_SELF=<string.Template object>, SCENE_PRIVATE=<string.Template object>) + namespace(NETWORK='$NETWORK', DEVICE=<string.Template object>, SCENE_PUBLIC=<string.Template object>, SCENE_PUBLIC_SELF=<string.Template object>, SCENE_PRIVATE=<string.Template object>, SCENE_ENV_PRIVATE=<string.Template object>)
    @@ -82,7 +82,7 @@ has_children: true
    PUBLISH_TOPICS = - namespace(NETWORK_LATENCY='$NETWORK/latency', DEVICE=<string.Template object>, PROC_REG=<string.Template object>, PROC_CTL=<string.Template object>, PROC_DBG=<string.Template object>, SCENE_PRESENCE=<string.Template object>, SCENE_PRESENCE_PRIVATE=<string.Template object>, SCENE_CHAT=<string.Template object>, SCENE_CHAT_PRIVATE=<string.Template object>, SCENE_USER=<string.Template object>, SCENE_USER_PRIVATE=<string.Template object>, SCENE_OBJECTS=<string.Template object>, SCENE_OBJECTS_PRIVATE=<string.Template object>, SCENE_RENDER=<string.Template object>, SCENE_RENDER_PRIVATE=<string.Template object>, SCENE_ENV=<string.Template object>, SCENE_ENV_PRIVATE=<string.Template object>, SCENE_PROGRAM=<string.Template object>, SCENE_PROGRAM_PRIVATE=<string.Template object>, SCENE_DEBUG=<string.Template object>) + namespace(NETWORK_LATENCY='$NETWORK/latency', DEVICE=<string.Template object>, SCENE_PRESENCE=<string.Template object>, SCENE_PRESENCE_PRIVATE=<string.Template object>, SCENE_CHAT=<string.Template object>, SCENE_CHAT_PRIVATE=<string.Template object>, SCENE_USER=<string.Template object>, SCENE_USER_PRIVATE=<string.Template object>, SCENE_OBJECTS=<string.Template object>, SCENE_OBJECTS_PRIVATE=<string.Template object>, SCENE_RENDER=<string.Template object>, SCENE_RENDER_PRIVATE=<string.Template object>, SCENE_ENV=<string.Template object>, SCENE_ENV_PRIVATE=<string.Template object>, SCENE_PROGRAM=<string.Template object>, SCENE_PROGRAM_PRIVATE=<string.Template object>, SCENE_DEBUG=<string.Template object>)
    diff --git a/content/python-api/utils.md b/content/python-api/utils.md index 9ac17e29..1b78e730 100644 --- a/content/python-api/utils.md +++ b/content/python-api/utils.md @@ -3,7 +3,7 @@ title: arena.utils parent: Python API has_children: true --- -arena-py API v1.0.2 +arena-py API v1.1.0
    diff --git a/content/python-api/utils/arena_telemetry.md b/content/python-api/utils/arena_telemetry.md index 3fe68778..f8ecc091 100644 --- a/content/python-api/utils/arena_telemetry.md +++ b/content/python-api/utils/arena_telemetry.md @@ -3,7 +3,7 @@ title: arena.utils.arena_telemetry parent: arena.utils grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -11,7 +11,7 @@ grand_parent: Python API arena.utils.arena_telemetry

    The ArenaTelemetry generates traces, metrics, and logs using OpenTelemetry (OTEL). -It can export using OTEL's protocol (OTLP), send JSON OTEL spans to MQTT, or to the console.

    +It can export using OTEL's protocol (OTLP), send JSON OTEL spans to MQTT, or to the console.

    The :envvar:ARENA_TELEMETRY environment variable enables the telemetry. The :envvar:OTLP_ENDPOINT environment variable defines the OTLP endpoint when OTLP is used.

    @@ -43,7 +43,7 @@ The :envvar:OTLP_ENDPOINT environment variable defines the OTLP end
    -

    Implementation of SpanExporter that sends spans to MQTT

    +

    Implementation of SpanExporter that sends spans to MQTT.

    @@ -180,7 +180,7 @@ before returning from this method.

    -

    Implementation of ARENA telemetry. +

    Implementation of ARENA telemetry. According to :envvar:ARENA_TELEMETRY, exports using OTLP, send JSON OTEL spans to MQTT, or to the console.

    @@ -194,14 +194,17 @@ According to :envvar:ARENA_TELEMETRY, exports using OTLP, send JSON
    -

    Return an ArenaTelemetry using given service name and id +

    Return an ArenaTelemetry using given service name and id. Provides utility calls that wrap open telemetry functionality to start spans, log events, and other.

    Creates a parent span for all the spans related to the program.

    -

    Args: - name: name of the service used with the telemetry backend - id: additional id used with the telemetry backend

    +
    Parameters
    + +
      +
    • str name: name of the service used with the telemetry backend (required).
    • +
    • str id: additional id used with the telemetry backend (optional).
    • +
    @@ -250,7 +253,7 @@ Provides utility calls that wrap open telemetry functionality to start spans, lo
    -

    Record exit status on error

    +

    Record exit status on error.

    @@ -265,7 +268,7 @@ Provides utility calls that wrap open telemetry functionality to start spans, lo
    -

    Wrapper to otel start_as_current_span; force context to be parent span

    +

    Wrapper to otel start_as_current_span; force context to be parent span.

    @@ -280,7 +283,7 @@ Provides utility calls that wrap open telemetry functionality to start spans, lo
    -

    Wrapper to otel start_as_current_span to start a process message span; force context to be parent span

    +

    Wrapper to otel start_as_current_span to start a process message span; force context to be parent span.

    @@ -295,7 +298,7 @@ Provides utility calls that wrap open telemetry functionality to start spans, lo
    -

    Wrapper to otel start_as_current_span to start a process message span; force context to be parent span

    +

    Wrapper to otel start_as_current_span to start a process message span; force context to be parent span.

    @@ -310,7 +313,7 @@ Provides utility calls that wrap open telemetry functionality to start spans, lo
    -

    Add event to given or current span

    +

    Add event to given or current span.

    @@ -325,7 +328,7 @@ Provides utility calls that wrap open telemetry functionality to start spans, lo
    -

    Set error on given or current span

    +

    Set error on given or current span.

    diff --git a/content/python-api/utils/cmd_interpreter.md b/content/python-api/utils/cmd_interpreter.md index 5f59b73f..2c3830d3 100644 --- a/content/python-api/utils/cmd_interpreter.md +++ b/content/python-api/utils/cmd_interpreter.md @@ -3,7 +3,7 @@ title: arena.utils.cmd_interpreter parent: arena.utils grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -11,17 +11,20 @@ grand_parent: Python API arena.utils.cmd_interpreter

    The ArenaCmdInterpreter is a simple line-oriented command interpreter that -allows to inspect library/program state. It looks at :envvar:ENABLE_INTERPRETER -to enable the interpreter.

    +allows to inspect library/program state. It looks at :envvar:ENABLE_INTERPRETER +to enable the interpreter.

    The .ArenaCmdInterpreter receives a .Scene instance and provides commands to inspect attributes and execute functions (callables) given to the constructor.

    -

    The commands available are: - show: displays attributes - info: excutes scene functions that output information - help: displays the commands available - exit: terminates the program

    +

    The commands available are:

    + +
      +
    • show: displays attributes
    • +
    • info: executes scene functions that output information
    • +
    • help: displays the commands available
    • +
    • exit: terminates the program
    • +
    diff --git a/content/python-api/utils/mqtt.md b/content/python-api/utils/mqtt.md index 7670ca28..deb12710 100644 --- a/content/python-api/utils/mqtt.md +++ b/content/python-api/utils/mqtt.md @@ -3,7 +3,7 @@ title: arena.utils.mqtt parent: arena.utils grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -45,7 +45,7 @@ some topic name.

    Return an iterator on all values associated with filters -that match the :topic

    +that match the :topic.

    diff --git a/content/python-api/utils/program_info.md b/content/python-api/utils/program_info.md index d13a6627..e8e33894 100644 --- a/content/python-api/utils/program_info.md +++ b/content/python-api/utils/program_info.md @@ -3,14 +3,14 @@ title: arena.utils.program_info parent: arena.utils grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0

    arena.utils.program_info

    -

    Collect information about the program execution, such as +

    Collect information about the program execution, such as activity times and number of messages sent/received.

    @@ -40,7 +40,7 @@ activity times and number of messages sent/received.

    -

    Return object public members only

    +

    Return object public members only.

    @@ -123,15 +123,18 @@ activity times and number of messages sent/received.

    -

    Returns a ProgramRunInfo. If an event loop is passed, will setup a periodic task to -update execution stats and perform a callback to notify of this update

    +

    Returns a ProgramRunInfo. If an event loop is passed, will setup a periodic task to +update execution stats and perform a callback to notify of this update.

    -

    Args: - evt_loop: an event loop to which we add a periodic task to update program stats - queue_len_callable: callable that returns a queue stats object - update_callback: callback when stats are updated - update_interval_ms: interval of the periodic task to update program stats - kwargs: additional attributes to add to the program info, e.g. web host, scene, namespace

    +
    Parameters
    + +
      +
    • object evt_loop: an event loop to which we add a periodic task to update program stats (optional).
    • +
    • object queue_len_callable: callable that returns a queue stats object (optional).
    • +
    • object update_callback: callback when stats are updated (optional).
    • +
    • int update_interval_ms: interval of the periodic task to update program stats (optional).
    • +
    • object kwargs: additional attributes to add to the program info, e.g. web host, scene, namespace (optional).
    • +
    @@ -279,7 +282,7 @@ update execution stats and perform a callback to notify of this update

    -

    Update stats when a message is received

    +

    Update stats when a message is received.

    @@ -294,7 +297,7 @@ update execution stats and perform a callback to notify of this update

    -

    Update stats when a message is published

    +

    Update stats when a message is published.

    @@ -309,7 +312,7 @@ update execution stats and perform a callback to notify of this update

    -

    Add program info to another dictionary

    +

    Add program info to another dictionary.

    diff --git a/content/python-api/utils/utils.md b/content/python-api/utils/utils.md index 83045a17..b21ddc7b 100644 --- a/content/python-api/utils/utils.md +++ b/content/python-api/utils/utils.md @@ -3,7 +3,7 @@ title: arena.utils.utils parent: arena.utils grand_parent: Python API --- -arena-py API v1.0.2 +arena-py API v1.1.0
    @@ -38,7 +38,7 @@ grand_parent: Python API
    -

    Turns a tuple into a string

    +

    Turns a tuple into a string.

    @@ -54,7 +54,7 @@ grand_parent: Python API
    -

    Reduces floating point numbers to ARENA granularity

    +

    Reduces floating point numbers to ARENA granularity.

    @@ -70,7 +70,7 @@ grand_parent: Python API
    -

    Repalces a key,val with a new key,val

    +

    Replaces a key,val with a new key,val.