gatos.module_control

tool Logical controls

Control one indexed engine, RCS unit, light, animation, docking port, or decoupler.

Use when: A change targets a fitted module rather than the vessel as a whole.
Availability: control_enabled; docking pushoff additionally requires debug_namespace.

Input

Field	Type	Requirement	Description
`operation`	`string`	Required	Logical operation listed below or dotted canonical action.
`vessel_id`	`string`	Required	Raw target vessel id.
`ordinal`	`integer`	Required	Zero-based module ordinal from the vessel document.
`value`	`number`	Optional · 0	Operation-specific scalar.
`values`	`number[] \| null`	Optional · null	Operation-specific numeric vector.
`token`	`string \| null`	Optional · null	Operation-specific named value.
`aux`	`string \| null`	Optional · null	Operation-specific secondary value.

Operation call shapes

Choose an operation below. Its required payload and a complete call stay together—there is no second table to cross-reference.

`engine_active | rcs_active | light_on`

Canonical action: engine.active | rcs.active | light.on

Enable or disable one indexed engine, RCS controller, or light.

Arguments for this operation

{ operation, vessel_id, ordinal, value: 0 | 1 }

Example

gatos.module_control({"operation":"engine_active","vessel_id":"Hunter","ordinal":0,"value":1})

`engine_minimum_throttle`

Canonical action: engine.min_throttle

Set one engine's normalized minimum-throttle fraction. engine_min_throttle is an alias.

Arguments for this operation

{ operation: "engine_minimum_throttle", vessel_id, ordinal, value: number  // 0..1 }

Example

gatos.module_control({"operation":"engine_minimum_throttle","vessel_id":"Hunter","ordinal":0,"value":0.15})

`light_brightness`

Canonical action: light.brightness

Set one light's brightness multiplier.

Arguments for this operation

{ operation: "light_brightness", vessel_id, ordinal, value: number  // >= 0 }

Example

gatos.module_control({"operation":"light_brightness","vessel_id":"Hunter","ordinal":2,"value":4})

`light_color`

Canonical action: light.color

Set one light's normalized RGB color.

Arguments for this operation

{ operation: "light_color", vessel_id, ordinal, values: [r, g, b]  // each 0..1 }

Example

gatos.module_control({"operation":"light_color","vessel_id":"Hunter","ordinal":2,"values":[1,0.25,0.05]})

`light_outer_angle | light_inner_angle`

Canonical action: light.outer_angle | light.inner_angle

Set spotlight cone angles; the inner angle cannot exceed the outer angle.

Arguments for this operation

{ operation, vessel_id, ordinal, value: degrees }

Example

gatos.module_control({"operation":"light_outer_angle","vessel_id":"Hunter","ordinal":2,"value":42})

`animation_goal | solar_deployment`

Canonical action: animation.goal

Drive an animation or solar deployment to a normalized goal.

Arguments for this operation

{ operation, vessel_id, ordinal, value: number  // 0..1 }

Example

gatos.module_control({"operation":"solar_deployment","vessel_id":"Hunter","ordinal":0,"value":1})

`undock | fire_decoupler`

Canonical action: docking.undock | decoupler.fire

Fire a one-shot indexed separation trigger. Inspect live module state before retrying.

Arguments for this operation

{ operation, vessel_id, ordinal }

Example

gatos.module_control({"operation":"undock","vessel_id":"Hunter","ordinal":0})

`pushoff`

Canonical action: debug.docking_pushoff

Set a docking port's debug undock push-off impulse. Requires debug_namespace.

Arguments for this operation

{ operation: "pushoff", vessel_id, ordinal, value: impulse_newton_seconds }

Example

gatos.module_control({"operation":"pushoff","vessel_id":"Hunter","ordinal":0,"value":250})

Call example

gatos.module_control({"operation":"engine_active","vessel_id":"Hunter","ordinal":0,"value":1})

Result

Command outcome for the selected module and canonical action.

Errors

ENOENT for vessel/module lookup; EOPNOTSUPP for a disabled decoupler; EINVAL for invalid values.