OBS Streaming: obs-websocket

belgian_style · February 15, 2020, 10:43pm

Has anyone integrated the OBS WebAPI (obs-websocket) into HASS core? I want to use a zwave lightswitch to trigger OBS functions and I haven’t seen anyone on either forum mentioning the other product. Here’s a list of available language APIs for obs-websocket, anyone have an idea on what the easiest way to link a below API with HASS?

Javascript (browser & nodejs): obs-websocket-js by Brendan Hagan
C#/VB.NET: obs-websocket-dotnet
Python 2 and 3: obs-websocket-py by Guillaume Genty a.k.a Elektordi
Python 3.5+ with asyncio: obs-ws-rc by Kirill Mysnik
Java 8+: obs-websocket-java by TwasiNET
Golang: go-obs-websocket by Chris de Graaf

Link to main GitHub if desired.

snicker · April 20, 2020, 5:54am

i’m interested in this as well… i have started live-streaming yard work and wanted to use motion detectors to switch the camera view.

I will look into this and see how difficult it would be to create an integration.

belgian_style · April 23, 2020, 2:34am

That would be awesome. I would love to see what you come up with! I don’t even know where to start but let me know if there is anything I can do to assist.

snicker · April 26, 2020, 4:00pm

I have been thinking about this over the past week and have some ideas but wanted to see what you thought, in terms of making this part of HomeAssistant.

This is the protocol doc, as in everything OBS Websocket can control:

github.com

Palakis/obs-websocket/blob/e277cae7998c2459e9accc832b79bc001adf8d3a/docs/generated/protocol.md

<!-- This file was generated based on handlebars templates. Do not edit directly! -->

# obs-websocket 4.7.0 protocol reference

# General Introduction
Messages are exchanged between the client and the server as JSON objects.
This protocol is based on the original OBS Remote protocol created by Bill Hamilton, with new commands specific to OBS Studio.

# Authentication
`obs-websocket` uses SHA256 to transmit credentials.

A request for [`GetAuthRequired`](#getauthrequired) returns two elements:
- A `challenge`: a random string that will be used to generate the auth response.
- A `salt`: applied to the password when generating the auth response.

To generate the answer to the auth challenge, follow this procedure:
- Concatenate the user declared password with the `salt` sent by the server (in this order: `password + server salt`).
- Generate a binary SHA256 hash of the result and encode the resulting SHA256 binary hash to base64, known as a `base64 secret`.
- Concatenate the base64 secret with the `challenge` sent by the server (in this order: `base64 secret + server challenge`).
- Generate a binary SHA256 hash of the result and encode it to base64.

This file has been truncated. show original

At a bare minimum, features I would want are

Start/stop stream
start/stop recording
Switch scenes
Enable/disable sources in scenes
Adjust audio (volume/mute) on sources

I think that the best way to represent OBS is as a “media player” entity.

input sources would represent scenes (changing input source would change the selected scene in OBS)
Streaming is handled by play/pause

Recording on/off would be a separate switch entity as the media player does not have a record option.

That gets us #1-3.

#4-5 are more difficult and i have a couple ideas

Create services for enabling/disabling & adjusting audio on sources. This kind of sucks because you have to create your own scripts and input entities to control this.
Create two switches for each source to enable/disable. Can’t handle volume in this way.
Create media_player entities for each source (on/off controls visibility, gives audio control). This could be a challenge if you have a lot of sources, as there will be many media_player entities

Which one do you think is most manageable from the UI?

snicker · April 26, 2020, 4:03pm

an additional challenge is that the “official” Python library to interact with the websocket connection is not using co-routines (making it sort of not friendly with HomeAssistant), but I think I can work around that

belgian_style · July 6, 2020, 4:45pm

Somehow I missed these posts… Did you get any farther on this?

sharkpunch · January 8, 2021, 3:30am

i’d also love something like this, i use OBS for a webcam so would love something that launched the app, powered on my camera and then loaded a profile and started the virtual camera via an automation

HeedfulCrayon · April 27, 2021, 7:27pm

I am also looking for a solution, or looking to develop a solution for this. I did however stumble upon this OBS Python - Real-time MQTT Status | OBS Forums

I have not been able to get this one working, but I have modified it, and will create a link to my github as well as instructions on how to get it working

HeedfulCrayon · April 29, 2021, 3:15am

So here is the script. It isn’t using the obs-websocket, rather the script function built into obs

gist.github.com

https://gist.github.com/HeedfulCrayon/9ff74d2aa1bc629ed17e0780f9a91a3d

update_mqtt_status_homeassistant.py

import json
import socket # Just so we can properly handle hostname exceptions
import obspython as obs
import paho.mqtt.client as mqtt
import ssl


# Meta
__version__ = '1.0.1'
__version_info__ = (1, 0, 1)

This file has been truncated. show original

Schneider · April 29, 2021, 11:03am

Nice! This is really useful, thanks!

HeedfulCrayon · April 29, 2021, 10:17pm

I have updated the gist and now you can start and stop streaming with a switch in HA

belgian_style · June 17, 2021, 6:10am

Awesome! I this is the link between the two I think I needed, thank U! Excited to finish my project now.

gros_fail · March 20, 2023, 6:13pm

Just passing by to thank you for the python script HeedfulCrayon, I use it to automate the streaming lighting. Is there any chance that we can change the scene from HA or retrieve the scene name in use?

noxx · July 26, 2024, 10:44am

i read there:

“…mqtt autodiscovery is on…”

where is this option in HA`?

noxx · July 26, 2024, 3:06pm

seems that this default on

possible to add a OBS Hotkey in HA`?