BRiTriggered User Guide

System Requirements

• Operating System: Windows 10/11 (64-bit)
• Memory: 64GB RAM recommended
• Graphics: NVIDIA RTX 3060 or better
• Software: Python 3.8 or later
• Hardware: IP camera with RTSP support
• Additional Software: OBS Studio (if you're using this for automated scene switching)

Installation

1. Download BRiTriggered from the official source
2. Extract the zip file to your preferred location
3. Run Setup.exe as Administrator
4. Choose "Full Install" and follow the on-screen prompts
5. Once complete, run BRiTriggered.exe

Alternative Installation Methods

If you prefer not to use the automatic installer, BRiTriggered offers two alternative installation methods:

Troubleshooting Common Installation Issues

• If "Python was not found" appears: Make sure you checked "Add Python to PATH" during installation
• If "pip is not recognized": Try using python -m pip install -r requirements.txt instead
• For package installation errors: Make sure you have a good internet connection
• If you see "DLL missing" errors: Install the Microsoft Visual C++ Redistributable 2015-2022: https://www.microsoft.com/en-us/download/details.aspx?id=48145

Uninstallation

To remove BRiTriggered:

1. Simply delete the BRiTriggered folder

If you want to uninstall Python (optional):

1. Go to Windows Settings > Apps
2. Find "Python 3.10" and "Python Launcher" in the list
3. Select each and click Uninstall

Note: If you're not sure whether you should remove Python, it's safer to leave it installed as it may be used by other applications on your system.

First Run

When you first launch BRiTriggered, you'll need to configure your camera and set up your first hotspot:

1. Click the Camera icon in the toolbar to set up your camera connection
2. Enter your camera credentials (see Camera Setup section for details)
3. Once connected, you'll see the camera feed in the main window
4. Use the Hotspot Editor to create your first motion detection area

Camera Connection

To connect BRiTriggered to your camera:

1. Click the Camera icon in the top toolbar
2. Enter the following information:
   • Username: Your camera's username (typically "admin")
   • Password: Your camera's password
   • IP Address: Your camera's IP address on your network
   • Port Number: The RTSP port (typically 80 or 554)
3. Adjust the Motion Sensitivity slider to set detection sensitivity
4. Click "Save" to connect to your camera

If you need to start over with default camera settings, click the "Reset Camera" button in the lower left of the dialog. This will restore all settings to default values.

RTSP Configuration

BRiTriggered works best with Amcrest UltraHD 4K PoE cameras, but should work with any camera that supports RTSP streaming. The RTSP URL is typically formatted as:

rtsp://username:password@ip-address:port/cam/realmonitor?channel=1&subtype=0

BRiTriggered will automatically construct this URL from the camera settings you provide.

Security Considerations

BRiTriggered takes security seriously:

• Password Encryption: For your security, as soon as you enter your camera password, it is immediately encrypted using machine-specific encryption
• Passwords are never stored in plain text, and all config files use the encrypted version
• Decryption only happens in memory at the moment of establishing a connection with your camera
• For added security, consider setting up your cameras on a separate network segment

Creating Hotspots

Hotspots are areas in the camera view where motion will be detected:

1. Click the "Add Hotspot" button in the toolbar
2. Click and drag on the camera feed to define the hotspot area
3. In the configuration dialog that appears:
   • Give your hotspot a descriptive name
   • Select what action should trigger when motion is detected
   • Set a specific cooldown time (optional)
   • Choose a color for the hotspot outline
4. Click "Save" to create the hotspot

Editing Hotspots

To modify an existing hotspot:

1. Right-click on the hotspot in the camera view
2. Select "Edit Hotspot" from the context menu
3. Make your changes in the configuration dialog
4. Click "Save" to apply your changes

You can also resize a hotspot by clicking and dragging its corners.

Deleting Hotspots

To remove a hotspot:

1. Right-click on the hotspot in the camera view
2. Select "Delete Hotspot" from the context menu
3. Confirm the deletion when prompted

Keystrokes

You can configure BRiTriggered to send keyboard shortcuts when motion is detected:

1. When creating or editing a hotspot, select "Keystroke" as the action type
2. Click in the "Key Combination" field
3. Press the key or key combination you want to trigger
4. The keystroke will be recorded and displayed in the field

Common uses include F-keys (F1-F12) for OBS scene switching or media control keys.

Sound Effects

To play a sound when motion is detected:

1. When creating or editing a hotspot, select "Sound" as the action type
2. Click "Browse" to select a sound file (.wav or .mp3)
3. Adjust the volume slider if needed
4. Click "Test" to preview the sound

BRiTriggered comes with sample sounds in the "sounds" folder, but you can use any .wav or .mp3 file.

Launching Programs

You can launch external applications when motion is detected:

1. When creating or editing a hotspot, select "Program" as the action type
2. Click "Browse" to select an executable (.exe) file
3. Optionally enter command-line arguments
4. Choose whether the program should run minimized

This feature is useful for launching scripts or utilities when specific events occur on your layout.

Scene Switching

One of the most powerful features of BRiTriggered is its ability to control OBS Studio scenes:

1. Ensure OBS Studio is installed and configured with your scenes
2. In OBS, go to File > Settings > Hotkeys
3. Assign hotkeys to each scene you want to control
4. In BRiTriggered, create hotspots that use the same keystrokes

When motion is detected, BRiTriggered will send the keystroke to OBS, switching to the corresponding scene.

Setting Up Hotkeys

For optimal OBS integration:

• Use function keys (F1-F12) for scene switching
• Ensure the hotkeys don't conflict with other applications
• Test each hotkey to verify it triggers the correct scene
• Consider using modifier keys (Ctrl, Alt, Shift) for more combinations

Best Practices

Tips for the best OBS integration experience:

• Keep OBS running before launching BRiTriggered
• Set appropriate cooldown times to prevent rapid scene switching
• Position your camera to minimize false triggers
• Consider using Studio Mode in OBS for smoother transitions
• Use the "Global Cooldown" option if you want to prevent multiple scenes from triggering at once

Cooldown Control

Cooldown prevents excessive triggering when continuous motion is detected:

• Global Cooldown: When enabled, all hotspots share a single cooldown timer
• Cooldown Duration: Time to wait after a trigger before allowing new triggers
• Per-Hotspot Cooldown: Each hotspot can have its own cooldown time, overriding the global setting

To access cooldown settings, click the gear icon in the toolbar and go to the "Cooldown" tab.

Motion Sensitivity

Adjusting sensitivity helps reduce false triggers or increase responsiveness:

• Higher sensitivity detects smaller movements but may cause false triggers
• Lower sensitivity requires more significant motion but reduces false triggers
• The optimal setting depends on your camera positioning and lighting conditions

You can adjust sensitivity in the Camera Setup dialog.

Debug Logging

For troubleshooting issues, BRiTriggered offers comprehensive logging:

1. Click the gear icon in the toolbar
2. Go to the "Advanced" tab
3. Enable "Debug Logging"

Log files are stored in the "logs" folder with the following characteristics:

• Date-time filename format for easy identification
• Automatic rotation when files reach 90MB in size
• Only the 5 most recent logs are kept to conserve disk space

Camera Issues

Problem	Solution
Cannot connect to camera	Verify the camera's IP address is correct Check username and password Ensure the camera is powered on and connected to your network Try the "Reset Camera" button to restore default settings
Camera feed is laggy	Check your network connection Reduce the resolution in your camera settings Close other applications using network bandwidth
Camera disconnects frequently	Check for network issues or interference Ensure your camera has a stable power supply Update your camera's firmware

Performance Issues

Problem	Solution
Application runs slowly	Close other resource-intensive applications Reduce the number of active hotspots Lower camera resolution Ensure your PC meets the recommended system requirements
High CPU usage	Reduce the frame rate in camera settings Use fewer simultaneous camera feeds Disable debug logging if enabled
Memory leak (increasing RAM usage)	Update to the latest version of BRiTriggered Restart the application regularly Report the issue with logs to the developer

Common Errors

Error Message	Solution
"Failed to connect to camera"	Check camera credentials and network connectivity Verify the camera supports RTSP streaming Make sure the port is not blocked by a firewall
"Could not trigger action"	Ensure the target application (e.g., OBS) is running Check that the keystroke doesn't conflict with other applications Verify that the sound file or program path still exists
"Configuration file corrupted"	Restore from a backup if available Delete the corrupted config file and let BRiTriggered create a new one You'll need to reconfigure your settings and hotspots