Guide / Controls / Reference

Pulse

A pulse is a decorative ring that flashes around a container the moment live data lands on it — a zero-wiring way to *see* events arriving. The ring expands outward (data collected / leaving) or contracts inward (data arriving / stored), with a brief glow along the resting border, then fades. It never intercepts touches and is invisible at rest.

Symbol
dot.radiowaves.left.and.right
Docs
Docs complete

Fields

7 fields, each with what it does.

Fields
FieldTypeDefaultWhat it does
eventeventtext—

Which server event triggers it

Makes the ring flash each time this socket event arrives, such as broadcast.

colorcolorcolor#34C759

Ring color

Colors the flashing ring and the glow along the border (default green).

directiondirectionchoiceone of 2outward

Which way the ring moves

Makes the ring either grow away from the group or shrink toward it.

  • outward defaultthe ring expands away from the group, as if data is leaving or collected
  • inwardthe ring contracts toward the group, as if data is arriving or stored
spreadspreadnumber0–1step 0.050.1

How far the ring travels

Sets how far the ring moves as a fraction of the group's size, 0 to 1 (default 0.1 is 10%).

durationdurationnumber0.1–10step 0.10.9

How long one pulse lasts

Sets the pulse length in seconds, from 0.1 to 10 (default 0.9).

curvecurvechoiceone of 5gentle

How the ring eases

Picks the easing of the ring's motion; the springy presets make it overshoot slightly.

  • snappyquick with a crisp stop
  • smoothan even natural glide
  • bouncyovershoots and settles
  • gentle defaulta calm slow ease (the default)
  • instantno easing, it jumps straight through
filterfilterobject—

Only pulse for matching data

Limits the pulse to events whose payload contains these key/value pairs, so other events are ignored.

Examples

3 examples, each one a control you can paste into a layout.

Live GPS collector

A green ring flashes outward whenever an iCloud reading arrives.

JSON 16 lines
{
  "type": "group",
  "id": "gps-collector",
  "label": "Live GPS",
  "grid": { "columns": 2, "rows": 2 },
  "children": [],
  "pulse": {
    "event": "broadcast",
    "filter": { "msg_type": "iCloudListen" },
    "direction": "outward",
    "color": "34C759",
    "spread": 0.12,
    "duration": 0.8,
    "curve": "bouncy"
  }
}

Open in CAR-TER

Queue flush

An inward blue ring marks data being stored, with a calm ease.

JSON 8 lines
{
  "type": "group",
  "id": "buffer",
  "label": "Buffer",
  "grid": { "columns": 2, "rows": 2 },
  "children": [],
  "pulse": { "event": "flush", "direction": "inward", "color": "5AC8FA", "duration": 1.2, "curve": "gentle" }
}

Open in CAR-TER

Any broadcast, big and snappy

No filter, so every broadcast flashes a wide, quick ring.

JSON 8 lines
{
  "type": "group",
  "id": "inbox",
  "label": "Inbox",
  "grid": { "columns": 2, "rows": 2 },
  "children": [],
  "pulse": { "event": "broadcast", "color": "FF9500", "spread": 0.3, "duration": 0.5, "curve": "snappy" }
}

Open in CAR-TER

Use the preview above to tune the colour, direction, ring width, curve, spread, and duration, then tap Fire Pulse — or flip Auto Pulse to watch it repeat as though readings were streaming in. The curve reuses the app's animation presets: gentle is a calm ease, while bouncy/smooth/snappy give the ring a springy overshoot.

On a group

Attach a pulse to any group and it flashes whenever its event arrives over the socket. An optional filter narrows which payloads count, matching keys the same way a Sync filter does.

In the app

The Location Metrics screen uses the same effect directly: the live-payload card pulses green outward each time a reading is collected, and the buffer card pulses inward each time the queue is flushed to the server.

  • Extensions — attach a pulse to a container
  • Sync — the event/filter mechanism pulses share
  • Animations — other motion in the system

Generated from ControlDocs/pulse.md. Something unclear or missing? Tell me.