hs.tangent.reserved.action -> table
alt
- toggles the 'ALT' function.nextKnobBank
- switches to the next knob bank.prevKnobBank
- switches to the previous knob bank.nextButtonBank
- switches to the next button bank.prevBasketBank
- switches to the previous button bank.nextTrackerballBank
- switches to the next trackerball bank.prevTrackerballBank
- switches to the previous trackerball bank.nextMode
- switches to the next mode.prevMode
- switches to the previous mode.goToMode
- switches to the specified mode, requiring a Argument with the mode ID.toggleJogShuttle
- toggles jog/shuttle mode.toggleMouseEmulation
- toggles mouse emulation.fakeKeypress
- generates a keypress, requiring an Argument with the key code.showHUD
- shows the HUD on screen.goToKnobBank
- goes to the specific knob bank, requiring an Argument with the bank number.goToButtonBank
- goes to the specific button bank, requiring an Argument with the bank number.goToTrackerballBank
- goes to the specific trackerball bank, requiring an Argument with the bank number.hs.tangent.fromHub -> table
connected
- a connection is established with the Hub.disconnected
- the connection is dropped with the Hub.initiateComms
- sent when the Hub wants to initiate communications.parameterChange
- a parameter was incremented.parameterReset
- a parameter was reset.parameterValueRequest
- the Hub wants the current value of the parameter.menuChange
- The menu was changed, +1
or -1
.menuReset
- The menu was reset.menuStringRequest
- The application should send a menuString
with the current value.actionOn
- An action button was pressed.actionOff
- An action button was released.modeChange
- The current mode was changed.transport
- The transport.unmanagedPanelCapabilities
- Send by the Hub to advertise an unmanaged panel.unmanagedButtonDown
- A button on an unmanaged panel was pressed.unmanagedButtonUp
- A button on an unmanaged panel was released.unmanagedEncoderChange
- An encoder (dial/wheel) on an unmanaged panel changed.unmanagedDisplayRefresh
- Triggered when an unmanaged panel's display needs to update.panelConnectionState
- A panel's connection state changed.hs.tangent.panelType -> table
hs.tangent.reserved.parameter -> table
transportRing
- transport ring.fakeKeypress
- sends a fake keypress.hs.tangent.toHub -> table
hs.tangent.automaticallySendApplicationDefinition -> boolean
true
.hs.tangent.ipAddress -> number
hs.tangent.port -> number
hs.tangent.callback() -> boolean
hs.tangent
. If the value provided is nil
, any currently existing callback function is removed.true
if successful otherwise false
id
for the callback:connected
- Connection to Tangent Hub successfully established.disconnected
- The connection to Tangent Hub was dropped.initiateComms
- Initiates communication between the Hub and the application.protocolRev
- The revision number of the protocol.numPanels
- The number of panels connected.panels
panelID
- The ID of the panel.panelType
- The type of panel connected.data
- The raw data from the Tangent HubparameterChange
- Requests that the application increment a parameter.paramID
- The ID value of the parameter.increment
- The incremental value which should be applied to the parameter.parameterReset
- Requests that the application changes a parameter to its reset value.paramID
- The ID value of the parameter.parameterValueRequest
- Requests that the application sends a ParameterValue (0x82)
command to the Hub.paramID
- The ID value of the parameter.menuChange
- Requests the application change a menu index by +1 or -1.menuID
- The ID value of the menu.increment
- The incremental amount by which the menu index should be changed which will always be an integer value of +1 or -1.menuReset
- Requests that the application changes a menu to its reset value.menuID
- The ID value of the menu.menuStringRequest
- Requests that the application sends a MenuString (0x83)
command to the Hub.menuID
- The ID value of the menu.actionOn
- Requests that the application performs the specified action.actionID
- The ID value of the action.modeChange
- Requests that the application changes to the specified mode.modeID
- The ID value of the mode.transport
- Requests the application to move the currently active transport.jogValue
- The number of jog steps to move the transport.shuttleValue
- An incremental value to add to the shuttle speed.actionOff
- Requests that the application cancels the specified action.actionID
- The ID value of the action.unmanagedPanelCapabilities
- Only used when working in Unmanaged panel mode. Sent in response to a UnmanagedPanelCapabilitiesRequest (0xA0)
command.panelID
- The ID of the panel as reported in the InitiateComms
command.numButtons
- The number of buttons on the panel.numEncoders
- The number of encoders on the panel.numDisplays
- The number of displays on the panel.numDisplayLines
- The number of lines for each display on the panel.numDisplayChars
- The number of characters on each line of each display on the panel.unmanagedButtonDown
- Only used when working in Unmanaged panel mode. Issued when a button has been pressed.panelID
- The ID of the panel as reported in the InitiateComms
command.buttonID
- The hardware ID of the buttonunmanagedButtonUp
- Only used when working in Unmanaged panel mode. Issued when a button has been released.panelID
- The ID of the panel as reported in the InitiateComms
command.buttonID
- The hardware ID of the button.unmanagedEncoderChange
- Only used when working in Unmanaged panel mode. Issued when an encoder has been moved.panelID
- The ID of the panel as reported in the InitiateComms
command.paramID
- The hardware ID of the encoder.increment
- The incremental value.unmanagedDisplayRefresh
- Only used when working in Unmanaged panel mode. Issued when a panel has been connected or the focus of the panel has been returned to your application.panelID
- The ID of the panel as reported in the InitiateComms
command.panelConnectionState
panelID
- The ID of the panel as reported in the InitiateComms
command.state
- The connected state of the panel, true
if connected, false
if disconnected.hs.tangent.connect(applicationName, systemPath[, userPath]) -> boolean, errorMessage
true
on success, otherwise nil
nil
if success
is true
.hs.tangent.connected() -> boolean
true
if connected, otherwise false
hs.tangent.disconnect() -> none
hs.tangent.isTangentHubInstalled() -> boolean
true
if Tangent Hub is installed otherwise false
.hs.tangent.send(byteString) -> boolean, string
true
if connected, otherwise false
hs.tangent.sendAllChange() -> boolean, string
true
if successful, or false
and an error message if not.hs.tangent.sendApplicationDefinition([appName, systemPath, userPath]) -> boolean, string
true
if successful, false
and an error message if there was a problem.hs.tangent.sendDisplayText(messages[, doubleHeight]) -> boolean, string
boolean
s indicating if the corresponding message is double-height.true
if successful, or false
and an error message if not.hs.tangent.sendHighlightControl(targetID, active) -> boolean, string
true
, the control is highlighted, otherwise it is not.true
if sent successfully, false
and an error message if no.hs.tangent.sendIndicateControl(targetID, indicated) -> boolean, string
true
, the control is indicated, otherwise it is not.true
if sent successfully, false
and an error message if no.hs.tangent.sendMenuString(menuID, value[, atDefault]) -> boolean, string
true
the value represents the default. Otherwise false
.true
if successful, or false
and an error message if not.hs.tangent.sendModeValue(modeID) -> boolean, string
true
if successful, or false
and an error message if not.hs.tangent.sendPanelConnectionStatesRequest())
true
if sent successfully, false
and an error message if not.hs.tangent.sendParameterValue(paramID, value[, atDefault]) -> boolean, string
true
the value represents the default. Defaults to false
.true
if successful, or false
and an error message if not.hs.tangent.sendRenameControl(targetID, newName) -> boolean, string
true
if successful, false
and an error message if not.hs.tangent.sendUnmanagedDisplayWrite(panelID, displayID, lineNum, pos, message) -> boolean, string
1
as the top line (Unsigned Int)1
as the first column (Unsigned Int)true
if successful, or false
and an error message if not.hs.tangent.sendUnmanagedPanelCapabilitiesRequest(panelID) -> boolean, string
true
if successful, or false
and an error message if not.hs.tangent.setLogLevel(loglevel) -> none