Anatomy of a Module

The Inspector view of an OSC Module

The Inspector view of an OSC Module

Header

When selecting a module, you can find at the very top a header with some controls. You can here choose to enable/disable the module. When a module is disabled, it will not update or send anything. Depending on whether the module is able to receive and/or send data, you can choose to activate/deactivate the logging of all data received and/or sent from this module with the Log Incoming / Log Outgoing buttons. If enabled, you'll be able to check in the Logger panel what's going on with this module.

Parameters

This section provides all the needed parameters to configure the modules, such as Host and port configuration for network modules, or device name for MIDI controllers, etc. You can find more about a particular module's parameter in its dedicated page.

Values

This is an important part of the module. The values are all the elements that you will be able to use when creating interactions. Each module has its own set of values, and some modules don't have any if they're not supposed to receive anything or if the Input parameter is deactivated (for network module for instance).

https://bkuperberg.gitbook.io/~gitbook/image?url=https%3A%2F%2F654853773-files.gitbook.io%2F~%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-M0J6klA7kDd2pwFQXYj%252F-M0J77Q7DvhqgPT4biK8%252F-M0J7HJ7gjZvBJPBDdVN%252Fosc_values.png%3Fgeneration%3D1581959445368445%26alt%3Dmedia&width=768&dpr=4&quality=100&sign=df54aee9852ea8b954d48c67034e6bffd31adf8fb8052cbc5ff40f07db1cb14a

Scripts

The script section allows you to create more complex logic for this module. You can find more about scripts in the dedicated Scripts page.

https://bkuperberg.gitbook.io/~gitbook/image?url=https%3A%2F%2F654853773-files.gitbook.io%2F~%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-M0J6klA7kDd2pwFQXYj%252F-M0J77Q7DvhqgPT4biK8%252F-M0J7HJ9O96CRlonDa7_%252Fmodule_scripts.png%3Fgeneration%3D1581959445990412%26alt%3Dmedia&width=768&dpr=4&quality=100&sign=619c59ef7bf97f7680d86a7864cd91ece983db133c45ac3702e2b32a751fbbec

Command Tester

The command tester is a handy tool to be able to test the functionality of your module by sending commands manually. It is not affecting the rest of the software, and allows you to just verify that the communication between Chataigne and your software or device is functioning properly.

https://bkuperberg.gitbook.io/~gitbook/image?url=https%3A%2F%2F654853773-files.gitbook.io%2F~%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-M0J6klA7kDd2pwFQXYj%252F-M0J77Q7DvhqgPT4biK8%252F-M0J7HJBhvJC-9PhbiiE%252Fcommand-tester.png%3Fgeneration%3D1581959445580059%26alt%3Dmedia&width=768&dpr=4&quality=100&sign=4855cd24306d79804f0c5a716a6666f6f4aa1e0a816ef4dc69045a5e7e85e47d

When testing commands, first set your parameters and then hit the "Trigger" buttons. If you want to send the command every time a parameter of this command has changed, you can check the "Auto Trigger" option.

Templates

The templates are a good way to customize a module for a specific use without having to create your own custom module. You can create your own custom commands, by creating a new Template and choosing a base command to derive from. Then you can customize it, and choose which fields are editable, which are not, and setup default mapping behaviors.

https://bkuperberg.gitbook.io/~gitbook/image?url=https%3A%2F%2F654853773-files.gitbook.io%2F~%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-M0J6klA7kDd2pwFQXYj%252F-M0J77Q7DvhqgPT4biK8%252F-M0J7HJDxbhX1S4LhcDG%252Ftemplate.png%3Fgeneration%3D1581959445822251%26alt%3Dmedia&width=768&dpr=4&quality=100&sign=efb4863dc0225e0b585023629febb3adc2068fb3027f8df5a78de52ef1c9675a

All Modules

Protocol

OSC

OSCQuery

MIDI

DMX

Serial

UDP

TCP Client

TCP Server

HTTP

Websocket Client

Websocket Server

MQTT

PJLink

PosiStageNet

Ableton Link

Hardware

Sound Card

Wiimote

JoyCon

Keyboard

Mouse

Gamepad

Kinect V2

StreamDeck

LoupeDeck

GPIO

Software

DLight

HeavyM

MadMapper

Millumin

QLab

Reaper

Resolume

Watchout

Powerpoint

Generator

Metronome

Signal

System

Time

OS

Special Modules

Community Modules