Reference
Enumerations
The public enumeration types of the SDK and their values.
| Value |
Number |
Description |
Jpeg |
0 |
|
Rgb24 |
1 |
|
Gray8 |
2 |
|
DriveIntent
What the route asks at the next junction; the planner needs it because the camera cannot know where the route turns.
| Value |
Number |
Description |
Follow |
0 |
Follow the road / sidewalk (also straight through a junction). |
Left |
1 |
|
Right |
2 |
|
KofaLogLevel
| Value |
Number |
Description |
Trace |
0 |
|
Debug |
1 |
|
Information |
2 |
|
Warning |
3 |
|
Error |
4 |
|
Critical |
5 |
|
KomodCategory
| Value |
Number |
Description |
Other |
0 |
|
Source |
1 |
|
Sensor |
2 |
|
Controller |
3 |
|
Actuator |
4 |
|
Vision |
5 |
|
Ai |
6 |
|
Visualization |
7 |
|
Converter |
8 |
|
Service |
9 |
|
System |
10 |
|
Connectivity |
11 |
|
KomodHealth
| Value |
Number |
Description |
Unknown |
0 |
|
Ok |
1 |
|
Warning |
2 |
|
Error |
3 |
|
KomodKind
Where a Komod lives.
| Value |
Number |
Description |
Node |
0 |
A graph node: instances are created and linked in the graph editor. |
Extension |
1 |
A package extension: not part of the graph. The runtime keeps exactly one instance of it running while its package is enabled and the extension is switched on (Komods page, "Bővítmény" category); then its UI page appears in the "Bővítmények" menu and it goes into the KOFA Lite export (its Extensions menu) too. |
MarkRounding
Which side a course mark is left on.
| Value |
Number |
Description |
None |
0 |
A point to reach (finish, harbor), not to round. |
Port |
1 |
Leave the mark to port (the boat goes around it counter-clockwise). |
Starboard |
2 |
Leave the mark to starboard (clockwise). |
MastRig
Where the forestay meets the mast.
| Value |
Number |
Description |
Masthead |
0 |
|
Fractional |
1 |
|
PortDirection
| Value |
Number |
Description |
In |
0 |
|
Out |
1 |
|
PortQosKind
| Value |
Number |
Description |
Latest |
0 |
One element buffer, a new value replaces the unread one (sensors, camera, control). |
Queue |
1 |
FIFO with a capacity; when full the oldest element is dropped and counted (events, logs). |
RelayPriority
How a Komod (or one of its outputs) is treated in relay (remote) sessions; local sessions are not affected. Ordered from the least to the most restrictive.
| Value |
Number |
Description |
Auto |
0 |
Not set: a Komod defaults to RelayPriority.High (RelayPriority.Low with bulk outputs), a port inherits its Komod's value. |
High |
1 |
Always streamed, but only small traffic: the server measures it and throttles it above the budget. |
Low |
2 |
May be large (camera frames, grids), but only updated when the server and the relay link have spare capacity. |
None |
3 |
No data is streamed to relay sessions; commands and UI inputs still work. |
Blocked |
4 |
No communication with relay sessions at all: no streams, commands, UI inputs or instance API. Komod level only. |
RoadMapEdgeKind
| Value |
Number |
Description |
Road |
0 |
Street centerline between intersections (cars). |
Sidewalk |
1 |
Sidewalk centerline (pedestrians, small robots). |
Crossing |
2 |
Crosswalk across a street, between two sidewalk corners. |
Path |
3 |
Footpath, e.g. in a park. |
SailAdviceCategory
What a piece of sailing advice is about (the advisor shows one at a time, in this order of priority).
| Value |
Number |
Description |
Idle |
0 |
The pilot is not advising (stopped, or no position yet). |
Alarm |
1 |
|
Manoeuvre |
2 |
|
Heel |
3 |
|
Steer |
4 |
|
Main |
5 |
|
Jib |
6 |
|
Hold |
7 |
Holding station (waiting, at the end of the route). |
Ok |
8 |
Nothing to change. |
SailAdviceUrgency
| Value |
Number |
Description |
Info |
0 |
|
Attention |
1 |
|
Alarm |
2 |
|
SceneObstacleSource
| Value |
Number |
Description |
Range |
0 |
Distance sensor reading. |
Vision |
1 |
Seen by the model. |
VehicleTypes
Combinable flags ([Flags]).
| Value |
Number |
Description |
None |
0 |
|
Car |
1 |
|
Sailboat |
2 |
|
Any |
3 |
|
ViewKind
| Value |
Number |
Description |
Page |
0 |
Full page: /instances/{instanceId}. |
Widget |
1 |
Dashboard tile. |
Settings |
2 |
Custom settings editor (otherwise a form is generated from the settings schema). |
WindKind
| Value |
Number |
Description |
Apparent |
0 |
|
True |
1 |
|
WorldManeuverKind
| Value |
Number |
Description |
Tack |
0 |
A sailboat's tack (through the wind's eye). |
Gybe |
1 |
A sailboat's gybe (stern through the wind). |
WorldTraceSource
How an obstacle of a WorldTrace got into the seen world.
| Value |
Number |
Description |
SegmentationFoot |
0 |
The segmentation saw an obstacle; placed where its foot meets the ground (the water) below it in the image. |
SegmentationStereo |
1 |
The segmentation saw an obstacle; placed at the stereo depth measured there. |
StereoOverride |
2 |
The segmentation saw free ground (water) there, but the stereo pair measured something standing. |
Stereo |
3 |
A stereo point high above the ground (the water), whatever the segmentation saw. |
Far |
4 |
An obstacle whose foot could not be placed (near the horizon), kept off as a far obstacle (water mode). |
KOFA