Tutorials

Step-by-step guides to help you get the most out of BrightOS.

Getting Started Tutorials

Tutorial 1: Your First BrightOS Experience (Web)

Difficulty: Beginner | Time: 10 minutes

Learn how to use BrightOS in your browser without installing anything.

What You'll Learn

How to access the web interface
Running a simple script
Understanding the BrightOS interface

Steps

Open the Web Interface
- Visit the BrightOS Web Interface
- The interface should load in your browser
Explore the Interface
- Look at the main window with dark theme
- Notice the menu bar at the top
- Check the status bar at the bottom
Load a Sample Script
- Click on "Scripts" menu
- Select a sample script from the list
- Read the script description
Run Your First Script
- Click the "Run" button
- Observe the output in the console
- Check the status messages

Success!

You've successfully run your first BrightOS script in the browser! 🎉

Tutorial 2: Installing BrightOS Desktop

Difficulty: Beginner | Time: 15 minutes

Set up BrightOS on your Windows or Linux computer.

What You'll Learn

How to download the launcher
Installing dependencies automatically
Running BrightOS for the first time

Requirements

Windows 10+ or Linux
Internet connection
Python 3.7+ (will be checked automatically)

Steps for Windows

Download the Launcher
- Go to the releases page
- Find the latest launcher release (look for tags starting with "launcher-")
- Download BrightOS-Launcher.exe
- Save it to a folder you can easily access
Run the Launcher
- Double-click BrightOS-Launcher.exe
- Windows SmartScreen might appear - click "More info" → "Run anyway"
- The launcher will automatically:
  - Check for Python installation
  - Download BrightOS files
  - Install dependencies
  - Create necessary directories
First Launch
- Wait for the launcher to complete setup
- BrightOS window will open automatically
- You'll see the main GUI with dark theme

Steps for Linux

Download the Launcher
- Go to the releases page
- Find the latest launcher release (look for tags starting with "launcher-")
- Download launcher.py
Make it Executable (Optional)
bash
```
chmod +x launcher.py
```
1
Run the Launcher
bash
```
python3 launcher.py
```
1
- The launcher will automatically handle setup
- BrightOS will launch when ready

Pro Tip

The launcher automatically checks for updates every time you run it!

Tutorial 3: Manual Installation

Difficulty: Intermediate | Time: 10 minutes

Install BrightOS manually for more control over the setup.

What You'll Learn

Manual installation process
Dependency management
Directory structure

Requirements

Python 3.7 or higher
pip (Python package manager)
Git (optional)

Steps

Download BrightOS Files
Option A - Using Git:
bash
```
git clone https://github.com/TheCrazy8/Blaze-Official.git
cd Blaze-Official
```
1
2
Option B - Manual Download:
- Go to the releases page
- Find the latest BrightOS release
- Download BrightOS.py and requirements.txt
- Save to a folder
Install Dependencies
bash
```
pip install -r requirements.txt
```
1

Create Directories

Windows:

cmd

mkdir "%USERPROFILE%\AppData\Local\BrightOS\Plugins"
mkdir "%USERPROFILE%\AppData\Local\BrightOS\Scripts"

Linux/macOS:

bash

mkdir -p ~/.brightos/Plugins
mkdir -p ~/.brightos/Scripts

Run BrightOS
bash
```
python3 BrightOS.py
```
1

Note

With manual installation, you'll need to manually check for updates by downloading new releases.

Arduino Setup Tutorials

Tutorial 4: Setting Up Arduino Uno R4 WiFi

Difficulty: Intermediate | Time: 30 minutes

Connect your Arduino Uno R4 WiFi board to BrightOS.

What You'll Need

Arduino Uno R4 WiFi board
USB cable
Arduino IDE installed
WiFi network

Steps

Install Arduino IDE
- Download from arduino.cc
- Install following the platform-specific instructions
Install Telemetrix4UnoR4 Library
- Open Arduino IDE
- Go to Sketch → Include Library → Manage Libraries
- Search for "Telemetrix4UnoR4"
- Click Install
- Wait for installation to complete
Create WiFi Credentials File
- In Arduino IDE, create a new tab: File → New Tab
- Name it arduino_secrets.h
- Add the following code:
cpp
```
// WiFi credentials for Arduino Uno R4 WiFi
#define SECRET_SSID "Your_WiFi_Network_Name"
#define SECRET_PASS "Your_WiFi_Password"
```
1
2
3
- Replace with your actual WiFi credentials
- Save the file
Security Note
Never commit WiFi credentials to version control! Keep arduino_secrets.h in your .gitignore file if sharing your project publicly.
Load the Auto-Discovery Sketch
- Clone or download the Blaze repository
- Open arduino/WiFi_Telemetrix4UnoR4WiFi_AutoDiscovery.ino
- Verify the code compiles (checkmark button)
Upload to Arduino
- Connect Arduino via USB
- Select the correct board: Tools → Board → Arduino Uno R4 WiFi
- Select the correct port: Tools → Port
- Click Upload (arrow button)
- Wait for "Done uploading" message

Verify Connection

Open Serial Monitor: Tools → Serial Monitor
Set baud rate to 115200
You should see:

WiFi connected successfully!
========================================
SSID: YourNetworkName
IP Address: 192.168.1.xxx
========================================

Success!

Your Arduino is now ready to work with BrightOS! The auto-discovery feature means BrightOS will automatically find it.

Tutorial 5: Connecting Arduino to BrightOS

Difficulty: Beginner | Time: 5 minutes

Connect your configured Arduino to BrightOS.

Prerequisites

Arduino Uno R4 WiFi configured (Tutorial 4)
BrightOS installed (Tutorial 2 or 3)
Both on the same WiFi network

Method 1: Auto-Discovery (Recommended)

Start Arduino
- Power on your Arduino (USB or external power)
- Wait for it to connect to WiFi (usually 5-10 seconds)
Launch BrightOS
- Run BrightOS launcher or python3 BrightOS.py
- BrightOS will automatically search for your Arduino
- Look for "Arduino discovered" message
Verify Connection
- Check the status bar for "Connected to Arduino"
- Green indicator shows successful connection

Method 2: Manual Configuration

Get Arduino IP Address
- Open Arduino Serial Monitor
- Note the IP address displayed
Configure BrightOS
- Launch BrightOS
- Click "Configure Telemetrix"
- Enter Arduino IP address: 192.168.1.xxx
- Click "Connect"
Save Configuration
- BrightOS will remember this IP for next time
- Or set environment variable ARDUINO_IP_ADDRESS

Troubleshooting

If connection fails:

Ensure both devices are on the same network
Check firewall settings
Verify Arduino IP hasn't changed (use DHCP reservation)
Restart both devices

Plugin Development Tutorials

Tutorial 6: Creating Your First Plugin

Difficulty: Intermediate | Time: 45 minutes

Create a custom BrightOS plugin to extend functionality.

What You'll Learn

Plugin structure
BrightOS API basics
Loading and testing plugins

Prerequisites

BrightOS installed
Basic Python knowledge
Text editor or IDE

Steps

Create Plugin Directory
- Navigate to your Plugins folder:
  - Windows: %USERPROFILE%\AppData\Local\BrightOS\Plugins\
  - Linux/macOS: ~/.brightos/Plugins/
- Create a new folder: my_first_plugin

Create Plugin File

Inside my_first_plugin, create __init__.py
Add the following code:

python

"""
My First Plugin
A simple plugin that greets the user
"""

class MyFirstPlugin:
    def __init__(self):
        self.name = "My First Plugin"
        self.version = "1.0.0"
        self.description = "A simple greeting plugin"
    
    def initialize(self):
        """Called when plugin is loaded"""
        print(f"{self.name} v{self.version} initialized!")
    
    def greet(self, name="User"):
        """Greet the user"""
        return f"Hello, {name}! Welcome to BrightOS!"
    
    def get_info(self):
        """Return plugin information"""
        return {
            "name": self.name,
            "version": self.version,
            "description": self.description
        }

# Plugin entry point
def load_plugin():
    return MyFirstPlugin()

Test Your Plugin
- Restart BrightOS
- Check the console for initialization message
- Your plugin should appear in the plugins list

Use Your Plugin

Access from BrightOS scripts:

python

plugin = get_plugin("My First Plugin")
message = plugin.greet("Alice")
print(message)  # Output: Hello, Alice! Welcome to BrightOS!

Next Steps

Expand your plugin with:

Arduino hardware control
File operations
User interface elements
Configuration options

See the Development Guide for more advanced plugin features.

Tutorial 7: Creating a Simple Script

Difficulty: Beginner | Time: 20 minutes

Write a simple BrightOS script.

What You'll Learn

Script structure
Using BrightOS functions
Saving and running scripts

Steps

Create Script File
- Navigate to Scripts folder:
  - Windows: %USERPROFILE%\AppData\Local\BrightOS\Scripts\
  - Linux/macOS: ~/.brightos/Scripts/
- Create hello_world.py

Write Script Code

python

"""
Hello World Script
Description: A simple script that prints a greeting
Author: Your Name
Version: 1.0
"""

def main():
    print("="*50)
    print("Hello from BrightOS!")
    print("This is my first custom script.")
    print("="*50)
    
    # Get user input
    name = input("What's your name? ")
    print(f"\nNice to meet you, {name}!")
    print(f"Welcome to the BrightOS community!")

if __name__ == "__main__":
    main()

Run Your Script
- Open BrightOS
- Go to Scripts menu
- Select "hello_world"
- Click Run

Enhance Your Script Add Arduino interaction:

python

def blink_led(board, pin=13, times=3):
    """Blink an LED on the Arduino"""
    import time
    
    board.set_pin_mode_digital_output(pin)
    
    for i in range(times):
        board.digital_write(pin, 1)
        time.sleep(0.5)
        board.digital_write(pin, 0)
        time.sleep(0.5)
    
    print(f"Blinked LED {times} times!")

Pro Tip

Check out the Examples page for more script ideas and templates!

Advanced Tutorials (Coming Soon)

Under Development

The following advanced tutorials are currently being developed. Check back soon or subscribe to the RSS Feed for updates when they're published!

Tutorial 8: Using Arduino Sensors

Difficulty: Advanced | Time: 60 minutes | Status: 🚧 In Development

Learn how to read sensor data from Arduino using BrightOS.

What You'll Need

Arduino Uno R4 WiFi configured
Temperature sensor (e.g., DHT11, DHT22)
Breadboard and wires

Check the Examples page for sensor examples while this tutorial is being completed.

Tutorial 9: Creating a Dashboard Plugin

Difficulty: Advanced | Time: 90 minutes | Status: 🚧 In Development

Build a custom dashboard plugin with real-time data visualization.

Check the Development Guide for UI plugin examples while this tutorial is being completed.

Video Tutorials

Coming Soon

Video tutorials are in production. Subscribe to the RSS Feed to be notified when they're available!

Need More Help?

Check the FAQ for common questions
Browse Examples for code samples
Read the Development Guide
Ask questions on GitHub Discussions
Report issues on GitHub Issues

Tutorial Requests

Have an idea for a tutorial? Request it on GitHub Discussions or open an issue with the "documentation" label.

Popular requests:

Working with motors and servos
Creating custom GUI interfaces
Multi-Arduino setups
Advanced Telemetrix features
Plugin best practices

Check back regularly for new tutorials!

Contributors

TheCrazy8

Changelog

Last edited 30 days ago

View full history

Tutorials ​

Getting Started Tutorials ​

Tutorial 1: Your First BrightOS Experience (Web) ​

What You'll Learn ​

Steps ​

Tutorial 2: Installing BrightOS Desktop ​

What You'll Learn ​

Requirements ​

Steps for Windows ​

Steps for Linux ​

Tutorial 3: Manual Installation ​

What You'll Learn ​

Requirements ​

Steps ​

Arduino Setup Tutorials ​

Tutorial 4: Setting Up Arduino Uno R4 WiFi ​

What You'll Need ​

Steps ​

Tutorial 5: Connecting Arduino to BrightOS ​

Prerequisites ​

Method 1: Auto-Discovery (Recommended) ​

Method 2: Manual Configuration ​

Plugin Development Tutorials ​

Tutorial 6: Creating Your First Plugin ​

What You'll Learn ​

Prerequisites ​

Steps ​

Tutorial 7: Creating a Simple Script ​

What You'll Learn ​

Steps ​

Advanced Tutorials (Coming Soon) ​

Tutorial 8: Using Arduino Sensors ​

What You'll Need ​

Tutorial 9: Creating a Dashboard Plugin ​

Video Tutorials ​

Need More Help? ​

Tutorial Requests ​

Contributors

Changelog

Tutorials

Getting Started Tutorials

Tutorial 1: Your First BrightOS Experience (Web)

What You'll Learn

Steps

Tutorial 2: Installing BrightOS Desktop

What You'll Learn

Requirements

Steps for Windows

Steps for Linux

Tutorial 3: Manual Installation

What You'll Learn

Requirements

Steps

Arduino Setup Tutorials

Tutorial 4: Setting Up Arduino Uno R4 WiFi

What You'll Need

Steps

Tutorial 5: Connecting Arduino to BrightOS

Prerequisites

Method 1: Auto-Discovery (Recommended)

Method 2: Manual Configuration

Plugin Development Tutorials

Tutorial 6: Creating Your First Plugin

What You'll Learn

Prerequisites

Steps

Tutorial 7: Creating a Simple Script

What You'll Learn

Steps

Advanced Tutorials (Coming Soon)

Tutorial 8: Using Arduino Sensors

What You'll Need

Tutorial 9: Creating a Dashboard Plugin

Video Tutorials

Need More Help?

Tutorial Requests