KratOsc

A large part of the Kratos API is accessible via OSC. This allows you to remotely control Kratos parameters from any third-party systems that can send OSC commands.

For Kratos to be able to receive OSC commands, you must first need to create a KratOSc Module.

This document describes the OSC address patterns used to control Kratos parameters.

Module

URI: /kratos/modules/<module_name>/<property>

property	argument	min	max	read/write	description
connected	int	0	1	r	Is module connected
description	string			r	Module description
enabled	int	0	1	r/w	Enable or disable the Module
info_message	string			r	Module status message

Module Parameters

URI: /kratos/modules/<module_name>/parameters/<parameter>

PSN Module Parameters

parameter	argument	min	max	read/write
offset	float,float,float			r/w
output_frequency	float			r
output_ip	string			r/w
output_name	string			r/w
output_port	int			r/w
output_send_only_valid	int	0	1	r/w
output_ttl	int			r/w
x_remap	string			r/w
y_remap	string			r/w
z_remap	string			r/w
tx_bytes_per_second	int			r

OSC Module Parameters

parameter	argument	min	max	read/write
input_address	string			r/w
input_enabled	int	0	1	r/w
input_port	int			r/w
output_address	string			r/w
output_enabled	int	0	1	r/w
output_port	int			r/w
rx_bytes_per_second	int			r
tx_bytes_per_second	int			r
feedbackperiodms (only for KratOSC)	int			r

HTTP Module Parameters

parameter	argument	min	max	read/write	description
baseAddress	string			r/w	Base URL for all requests (e.g., https://api.example.com)
timeout	int	0	60000	r/w	Request timeout in milliseconds
authType	string			r/w	Authentication type: None, Basic, Bearer. If the value is not in the allowed range, an error is returned and the value remains unchanged.
authUsername	string			r/w	Username for Basic authentication
authPassword	string			r/w	Password for Basic authentication
authToken	string			r/w	Token for Bearer authentication

Action Group

URI: /kratos/action_groups/<action_group_name>/<property>

property	argument	min	max	read/write	description
enabled	int	0	1	r/w	Enable or disable the ActionGroup

Action

URI: /kratos/action_groups/<action_group_name>/actions/<action_name>/<property>

property	argument	min	max	read/write	description
enabled	int	0	1	r/w	Enable or disable the Action

Action Parameters

URI: /kratos/action_groups/<action_group_name>/actions/<action_name>/parameters/<parameter>

Action Area

URI: /kratos/action_areas/<action_area_name>/<property>

property	argument	min	max	read/write	description
enabled	int	0	1	r/w	Enable or disable the ActionArea
visible	int	0	1	r/w	Set ActionArea visible
position	float,float,float			r/w	Set ActionArea position in meters
rotation	float,float,float			r/w	Set ActionArea rotation in degrees
scale	float,float,float			r/w	Set ActionArea position scale

Target

URI: /kratos/targets/<target_name>/<property>

property	argument	min	max	read/write	description
prediction	int	0	5000	r/w	Set Target prediction in ms
prediction_samples	int	0	5000	r/w	Set Target sample prediction
smoothing	int	0	5000	r/w	Set Target smoothing in ms
mode2d	bool			r/w	Set the target in 2D mode
manualZ	float	-10	10	r/w	Set Target Manual Z in meter
floorZ	float	-20	20	r/w	Set Target Floor Z in meter
manualSwitchZMode	int	0	2	r/w	Manual switch Z mode (0=Default, 1=UseManualZ, 2=CaptureZ)
manual	-			r/w	Set Target Manual control
tracker	int	0	64	r/w	Set Target Tracker Id
position	float,float,float			r/w	Set Target position
color	float,float,float			r/w	Set Target color

Kapta

URI: /kratos/kaptas/<kapta_name>/<property>

property	argument	min	max	read/write	description
connected	bool			r	Is Kapta connected
address	string			r	Kapta Ip Address
port	int	1024	65535	r	Kapta Port
bandwidth	int	0	2147483648	r	Network bandwidth in byte / seconds
temperature	float			r	Temperature in °C

Kapta - Camera

URI: /kratos/kaptas/<kapta_name>/cameras/<camera_name>/<property>

property	argument	min	max	read/write	description
enabled	bool			r	Connect/Disconnect from Kapta
connected	bool			r	Is Camera connected
fps	float	0		r	Measured Camera fps
bandwidth	int	0	2147483648	r	USB bandwidth in byte / seconds
temperature	float			r	Temperature in °C
exposure	float	0		w	Exposition time in ms
gain	float	0	100	w	Gain

BeaKon

URI: /kratos/uwb/<property>

property	argument	min	max	read/write	description
kit_name	string			r/w	Set BeaKon Kit Name
use_main_eliko_server	bool			r/w	Set Use main eliko server

Timecode

URI: /kratos/timecode/<property>

property	argument	min	max	read/write	description
enabled	bool			r/w	Enable LTC input
playback_enabled	bool			r/w	Enable playback input
connected	bool			r	Timecode is being received

Recorder

URI: /kratos/recorder/<property>

property	argument	min	max	read/write	description
enabled	bool			r/w	Enable Recorder
duration	int			r	Record duration in milliseconds
filesize	int			r	Record size in bytes

Screens

URI: /kratos/screens/<property>

property	argument	min	max	read/write	description
current_page	string			w	Select the page to control

Available pages are: Live, Kaptas, Areas, Actions, Scripts, BeaKons, User 1, User 2.

Simulator Settings

URI: /kratos/simulator/settings/<property>

property	argument	min	max	read/write	description
enable_kapta	bool			r/w	Enable Kapta simulator (playback from file)
enable_beakon	bool			r/w	Enable BeaKon simulator (playback from file)
enable_kore	bool			r/w	Enable Kore simulator (playback from file)
filepath	string			r/w	Path to the .kramera playback file
sync_with_timecode	bool			r/w	Sync simulation playback with timecode input

Simulator Playback

URI: /kratos/simulator/playback/<property>

property	argument	min	max	read/write	description
play	no argument			w	Start playback
pause	no argument			w	Pause playback
stop	no argument			w	Stop playback
seek	int			w	Seek to position in milliseconds
seek_next_frame	no argument			w	Advance one frame forward
seek_previous_frame	no argument			w	Go back one frame
seek_begin	no argument			w	Seek to the beginning
seek_end	no argument			w	Seek to the end

Kore

URI: /kratos/kore/<property>

property	argument	min	max	read/write	description
restart	no argument			w	Restart Kore software