Liking cljdoc? Tell your friends :D

clj-artnet.impl.shell.commands

Constructs and injects commands (DMX, RDM, State) into the node's flow loop.

Provides a functional API for queuing side effects and protocol actions to be processed by the shell/logic graph.

Constructs and injects commands (DMX, RDM, State) into the node's flow loop.

Provides a functional API for queuing side effects and protocol actions
to be processed by the shell/logic graph.
raw docstring

apply-state-commandclj

(apply-state-command state)

Builds an apply-state command map.

State map can contain :node, :network, :callbacks, :capabilities keys. Logic layer merges these updates into the live configuration.

Builds an apply-state command map.

State map can contain :node, :network, :callbacks, :capabilities keys.
Logic layer merges these updates into the live configuration.
sourceraw docstring

enqueue-command!clj

(enqueue-command! node command)

Injects a command map into the logic layer commands channel. The node must be a map containing a :flow key with a running graph.

Injects a command map into the logic layer commands channel.
The node must be a map containing a :flow key with a running graph.
sourceraw docstring

send-diagnostic!clj

(send-diagnostic! node opts)

Enqueues an ArtDiagData message for transmission.

Options:

  • :text -> ASCII text (max 512 chars)
  • :priority -> Priority keyword/byte
  • :logical-port -> Logical port ID

Diagnositics are sent to controllers subscribed via ArtPoll.

Enqueues an ArtDiagData message for transmission.

Options:
- :text         -> ASCII text (max 512 chars)
- :priority     -> Priority keyword/byte
- :logical-port -> Logical port ID

Diagnositics are sent to controllers subscribed via ArtPoll.
sourceraw docstring

send-dmx!clj

(send-dmx! node opts)

Enqueues an ArtDmx frame for transmission.

Options:

  • :data -> Channel bytes (byte array/ByteBuffer)
  • :net -> Net switch (0-127)
  • :sub-net -> Sub-Net switch (0-15)
  • :universe -> Universe (0-15)
  • :target -> Unicast target {:host ... :port ...} (Required)
  • :sequence -> Sequence number override (optional)

Art-Net 4 spec: ArtDmx must strictly be unicast.

Enqueues an ArtDmx frame for transmission.

Options:
- :data      -> Channel bytes (byte array/ByteBuffer)
- :net       -> Net switch (0-127)
- :sub-net   -> Sub-Net switch (0-15)
- :universe  -> Universe (0-15)
- :target    -> Unicast target {:host ... :port ...} (Required)
- :sequence  -> Sequence number override (optional)

Art-Net 4 spec: ArtDmx must strictly be unicast.
sourceraw docstring

send-rdm!clj

(send-rdm! node opts)

Enqueues an ArtRdm frame for transmission.

Options:

  • :rdm-packet -> RDM PDU bytes (without start code)
  • :address -> Port address / Net / Sub-Net / Universe
  • :target -> Unicast target {:host ... :port ...} (Required)

Art-Net 4 spec: ArtRdm must strictly be unicast.

Enqueues an ArtRdm frame for transmission.

Options:
- :rdm-packet -> RDM PDU bytes (without start code)
- :address    -> Port address / Net / Sub-Net / Universe
- :target     -> Unicast target {:host ... :port ...} (Required)

Art-Net 4 spec: ArtRdm must strictly be unicast.
sourceraw docstring

send-sync!clj

(send-sync! node)
(send-sync! node opts)

Broadcasts an ArtSync frame to synchronize output buffers.

Options:

  • :target -> Broadcast target (optional, defaults to broadcast)

Used to prevent visual tearing on large arrays.

Broadcasts an ArtSync frame to synchronize output buffers.

Options:
- :target -> Broadcast target (optional, defaults to broadcast)

Used to prevent visual tearing on large arrays.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close