chaun14 / obs-tally-node

A nice OBS studio tally light system using nodejs & arduino

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

obs-tally-node

A nice OBS tally light system using nodejs & arduino

Demo video

tellylight drawio

📄 Table of content

  1. Components
  2. Setup Instructions
  3. Discord server

🔍 Components

1 Server

The server is connected with the obs instance through the obs websocket plugin

For a source to be recognised as a camera, it is needed to follow the specific name formatting: CAMERANAMEHEREINCAPS_CAMERAID

image

for example, the main camera (id 0) will be named: MAIN_0

The camera with id 0 is triggered everytime a source in caps followed by _0 is shown in a scene image

2 Client

The client is connected through websocket (socket.io) to the server (⚠️ not directly to obs to avoid dealing with too much traffic)

Each client is assigned an id (check in the server part what the id means) and communicate with an arduino-like controller through serial console (autodetect COM port, self reconnect)

3 Hardware

The arduino controller waits for data from serial console and change colors following recieved instructions from the client

image image

📦 Setup instructions

Requirements:

  • Nodejs 16.9.0 or superior (not tested below)
  • An arduino like microcontroller with 2 leds (red & green) + resistor in needed
  • The system can run from the main host computer but is designed to run across different computers in a network

Installation:

  • First make sure to download the repository
  • Install dependencies: npm install
  • Rename config.example.js to config.js and fill it according to your needs:
    • for the server part provide the list of camera(s) and the obs websocket platform
    • for the client part provide the server ip adress and the camera id attached to this telly light
  • connect the arduino to the computer running the client, make sure it is running this script and setup your leds following the scheme before

🎧 Discord Server

If you need any help with this system or have a question regarding it, feel free to join and communicate with me on my discord server.

Discord Invite

About

A nice OBS studio tally light system using nodejs & arduino


Languages

Language:JavaScript 90.5%Language:C++ 9.5%