# Cue Commands

## Commands Affecting The Whole Cue

### Soft Stop

#### **/cue/stop**

Soft stops all the stagehands in the show.

### Run A Cue

#### **/cue/{cue\_number}/go**

Attempts to load and execute cue **cue\_number**

### Cue Ramp Time

#### **/cue/{cue\_number}/ramptime** **\[number]**

If **number** is present then Spikemark will attempt to set **cue\_number**'s ramp time. If **number** is not present then Spikemark will send a data message back with the **cue\_number**'s current ramp time.

### Cue Total Time

#### **/cue/{cue\_number}/totaltime** **\[number]**

If **number** is present then Spikemark will attempt to set **cue\_number**'s total time. If **number** is not present then Spikemark will send a data message back with the **cue\_number**'s current total time.

## Commands For Individual Movements

### Motor Movement Position

#### /cue/{cue\_number}/movement/{motor\_name}/position \[number]

If **number** is present then Spikemark will attempt to set **motor\_name**'s position in **cue\_number**. If **number** is not present then Spikemark will send a data message back with **motor\_name**'s current position in **cue\_number**'s.

{% hint style="warning" %}
Using this command to update the position will remove the existing spike. If you want to update a named spike's position then use either the [cue spike command](#motor-movement-spike-position) or the [motor spike command](https://docs.creativeconners.com/docs/spikemark/show-control/osc/motor-commands#motors-spike-position).
{% endhint %}

### Motor Movement Position

#### /cue/{cue\_number}/movement/{motor\_name}/position/scaled \[position\_int] \[scale\_float]

Spikemark attempts to set **motor\_name**’s position in **cue\_number** to **position\_int \* scale\_float**

{% hint style="warning" %}
Using this command to update the position will remove the existing spike. If you want to update a named spike's position then either the [cue spike command](#motor-movement-spike-position) or the [motor spike command](https://docs.creativeconners.com/docs/spikemark/show-control/osc/motor-commands#motors-spike-position).
{% endhint %}

### Motor Movement Spike Position

#### /cue/{cue\_number/movement/{motor\_name}/spike/position \[number]

If **number** is present then Spikemark attempts to set **motor\_name**'s spike's position in **cue\_number**. If **number** is not present then Spikemark sends a data message back with the **motor\_name**'s spike's position.

{% hint style="warning" %}
This will update a spikes position which will affect every cue that uses the spike.
{% endhint %}

### Motor Movement Spike Factor

#### /cue/{cue\_number}/movement/{motor\_name}/spike/factor \[number]

If **number** is present then Spikemark attempts to set **motor\_name**'s spike's factor in **cue\_number**. If **number** is not present then Spikemark sends a data message back with the **motor\_name**'s spike's factor.

{% hint style="warning" %}
This will update a spikes factor which will affect every cue that uses the spike.
{% endhint %}

### Motor Movement Spike Offset

#### /cue/{cue\_number}/movement/{motor\_name}/spike/offset \[number]

If **number** is present then Spikemark attempts to set **motor\_name**'s spike's offset in **cue\_number**. If **number** is not present then Spikemark sends a data message back with the **motor\_name**'s spike's offset.

{% hint style="warning" %}
This will update a spikes offset which will affect every cue that uses the spike.
{% endhint %}

### Motor Movement Speed

#### /cue/{cue\_number}/movement/{motor\_name}/speed \[number]

If **number** is present then Spikemark will attempt to set **motor\_name**'s speed in **cue\_number**. If **number** is not present then Spikemark will send a data message back with **motor\_name**'s current speed in **cue\_number**'s.

### Motor Movement Acceleration

#### /cue/{cue\_number}/movement/{motor\_name}/acceleration \[number]

If **number** is present then Spikemark will attempt to set **motor\_name**'s acceleration in **cue\_number**. If **number** is not present then Spikemark will send a data message back with **motor\_name**'s current acceleration in **cue\_number**'s.

### Motor Movement Ramp Time

#### /cue/{cue\_number}/movement/{motor\_name}/ramptime \[number]

If **number** is present then Spikemark will attempt to set **motor\_name**'s ramp time in **cue\_number**. If **number** is not present then Spikemark will send a data message back with **motor\_name**'s current ramp time in **cue\_number**'s.

### Motor Movement Total Time

#### /cue/{cue\_number}/movement/{motor\_name}/totaltime \[number]

If **number** is present then Spikemark will attempt to set **motor\_name**'s total time in **cue\_number**. If **number** is not present then Spikemark will send a data message back with **motor\_name**'s current total time in **cue\_number**'s.
