Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/docs/v2/plugins/TouchDesigner/010-gettingStartedTD.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ Remotely controlling your TouchDesigner installation with the SudoMagic plugin i

## Download the Plugin

The Signals plugin can be downloaded from the [GitHub page](https://github.com/SudoMagicCode/sudoSignals_tdClient_releases/releases). Optionally, you can download the sudoSignals TOX directly by [clicking here](https://github.com/SudoMagicCode/sudoSignals_tdClient_releases//releases/latest/download/SudoSignals.tox).
The Signals plugin can be downloaded from the [GitHub latest release](https://github.com/SudoMagicCode/sudoSignals_td_plugin/releases/latest). Optionally, you can download a specific release by looking through all of our plugin releases here [GitHub all releases](https://github.com/SudoMagicCode/sudoSignals_td_plugin/releases/latest). Please make sure to use a release that's at least version v2.0.0 or greater. Download the asset called `package.zip`.

## Extract
When you extract `package.zip` you'll see a directory called `sudoSignals`, in that director you'll find the `sudoSignals.tox` file that you can add to your project.

## Configure sudoSignals to launch a Process

Expand All @@ -35,6 +38,9 @@ If your project is not yet connected to Signals your controls and communication

:::

### Remove the External file Path
TouchDesigner has updated it's mechanics for handling external TOX files, if you drag and drop from your computer into your TOE file this will automatically fill in the external tox parameter on your component. If you don't intended on loading the sudoSignals plugin from disk, be sure to clear this parameter in TouchDesigner.

## Save your Project file

Save your project file on your computer. This will make sure that the sudoSignals TouchDesigner plugin is saved in your project.
Expand Down Expand Up @@ -101,6 +107,8 @@ Log messages from your process can be found on the logs tab in the dashboard.

![TD Plugin 010](/img/td-remote-setup/v2-remote-setup-010.png)

Alternatively, you can use the Plug's API to call for log messages by directly interacting with the TOX. To see more about accessing the Python extension for this component [click here](/v2/plugins/TouchDesigner/plugin-api)

<!-- links -->
[sudoSignals Client]: v2-dashboard.sudosignals.com/installer/sudoSignals_Installer.exe
[sudoSignals Client]: https://v2-dashboard.sudosignals.com/installer/sudoSignals_Installer.exe
[TouchDesigner sudoSignals Plugin]: https://github.com/SudoMagicCode/sudoSignals_td_plugin/releases/latest
6 changes: 6 additions & 0 deletions docs/docs/v2/plugins/TouchDesigner/020-manualConfigTD.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ For manual plugin configurations, the `Auto Start` parameter should be toggled o

## Configuring the Plugin in TouchDesigner

:::danger

We have not yet started testing manual configuration for the TouchDesigner plugin for V2 - please know that this will behave inconsistently

:::

Drag and drop the `sudoSignals` TOX into your network.

![Create Account 002](/img/td-manual-config/v2-td-manual-config-02.png)
Expand Down
43 changes: 43 additions & 0 deletions docs/docs/v2/plugins/TouchDesigner/030-TDPluginAPI.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: TouchDesigner Plugin API
slug: /v2/plugins/TouchDesigner/plugin-api
description: "TouchDesigner Plugin API"
---

# TouchDesigner Signals Plugin API

The TouchDesigner Signals plugin currently has a limited API that exposes some convenience operations for users. The current API implementation is focused on logging, with a plan to expand access in the future. For now, please use the custom parameters for the signals TOX as your primary mode of interaction for operations other than logging.

The `signals` class definition can be found at `sudoSignals/local/modules/signalsToxApi`

## Operator Access

Any given project should only contain one sudoSignals TOX, for that reason we have assigned a Global OP shortcut for this TOX `SudoSignals`. You can access this operator from anywhere in your TouchDesigner network by using:

```python
op.SudoSignals
```

## Logging

While you can generate logs by changing the contents of a log table, you may also find that it's easier to create log events by accessing Python extension for the sudoSignals TOX. The log method can be accessed by using `Send_log()` on the Signals TOX.

```python
op.SudoSignals(logLevel:str, message:str)
```

Log Level | Descriptor |
--- | --- |
LOG | Marked as LOG, useful for any logged data that has carries no warning. |
INFO | Marked as INFO, useful for any logged operation that provides direct information about a process or behavior. |
WARN | marked as WARNING, this is useful for operations that require some user intervention. |
CRIT | Marked as CRITICAL, this is useful for any operations that may cause system instability. |
ALERT | Marked as ALERT, this log type will generate an Alert. If you have signals configured to send email or SMS messages this will forward the contents of your alert to the selected notification medium. |

Your message should be a string less than 256 characters in length.

Example usage:

```python
op.SudoSignals("WARN", "Eep - something has gone wrong, check all the bananas")
```
4 changes: 2 additions & 2 deletions docs/docs/v2/plugins/TouchDesigner/TouchDesigner.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ TouchDesigner is a visual development platform that equips you with the tools yo

:::caution TouchDesigner Version

The current sudoSignals plugin is has been updated to use some of the latest features in TouchDesigner 2023 builds. **We recommend using 2023.32120 or later** when using the sudoSignals TouchDesigner plugin
The current sudoSignals plugin is has been updated to use some of the latest features in TouchDesigner 2023 builds. **We recommend using 2023.12230 or later** when using the sudoSignals TouchDesigner plugin

:::

<DocCardList />

<!-- links -->
{/* links */}
[TouchDesigner]: https://derivative.ca/