Octopus Home Pro Documentation

What's in the Box

• Octopus Home Pro device
• Power adapter (5V/3A USB-C)
• Quick start guide
• Safety information

System Requirements

• SMETS2 compatible smart meters (electricity and/or gas)
• WiFi network (2.4GHz)
• Mobile device with iOS (iPhone/iPad) or Android with Bluetooth capability for initial setup
• Power outlet near the installation location
• For development: Computer with VS Code installed

1. Launch the Setup Wizard

   Power on your Octopus Home Pro device and open the Octopus Energy R&D Labs app on your mobile device. You'll be greeted with the setup wizard welcome screen.

   

2. Enable Bluetooth Connection

   Ensure your Octopus Home Pro device is switched on. Enable Bluetooth on your smartphone and allow the app permission to access Bluetooth. Click "Continue" to proceed.

   

3. Device Discovery

   The app will search for nearby Octopus Home Pro devices. This may take a few moments as the app scans for Bluetooth signals.

   

4. Select Your Device

   Once discovered, your Octopus Home Pro device will appear in the list. Select your device and tap "Configure your device" to continue.

   

5. Wi-Fi Configuration

   Choose a Wi-Fi configuration method: either "Manual setup" or "WPS button" if your router supports it. The manual option allows you to enter your Wi-Fi credentials directly.

   

   
   Note: The Octopus Home Pro uses 2.4GHz WiFi. If you have a dual-WiFi network (same WiFi credentials across both 2.4GHz and 5GHz) you may experience some issues. Try to use WiFi credentials that are configured only for your 2.4GHz WiFi network.

6. Wi-Fi Connection Progress

   The app will configure your device's Wi-Fi connection. You'll see a progress screen with checkmarks as each step completes successfully.

   

7. Device Registration

   After Wi-Fi setup, the device will begin the registration process with Octopus Energy. This registers your device in the Octopus ecosystem.

   

   

   

8. Registration Complete

   Upon successful registration, you'll see a confirmation screen. Click "Return to the R&D labs app" to access your device dashboard.

   

9. Managing Your Device

   In the Device Management section, you'll see your newly added Octopus Home Pro listed. Tap on it to access device controls and information.

   

10. Device Status and Information

    The device dashboard shows general information about your Octopus Home Pro including its name, MAC address, serial number, IP address, and installation code.

    

11. Energy Monitoring

    Navigate to the "Charts" tab to view real-time energy consumption data and historical usage patterns from your smart meter.

    

Automatic Connection

In most cases, the device will automatically detect and connect to your smart meters. This process can take up to 10 minutes after the device is powered on and connected to your network.

The Octopus Energy mobile app will guide you through setup and automatically configure your Home Pro to connect to your smart meters. Make sure your mobile device has Bluetooth enabled and is within 3 meters of the Home Pro during setup.

1. Open the Octopus Home Pro dashboard
2. Navigate to Devices > Add Device
3. Select "Zigbee Device" as the device type
4. Click "Start Pairing" to put the coordinator in pairing mode
5. Follow the instructions for your specific Zigbee device to put it in pairing mode (typically by pressing a button or power cycling the device)
6. Once detected, the device will appear in the list. Give it a name and assign it to a room (optional)
7. Click "Finish" to complete the setup

1. On the dashboard, navigate to Apps > App Store
2. Browse or search for apps
3. Click on an app to view details
4. Click "Install" to download and install the app
5. Follow any setup instructions that appear

1. Click on the Extensions tab on the left panel in VS Code
2. Search for and install the 'remote-ssh' extension
3. Choose View -> Command Palette -> Remote-SSH: Connect to Host
4. Select '+ Add New SSH Host' and add:

   ssh -p 8023 -o HostKeyAlgorithms=+ssh-rsa root@<HPRO-IP>

   where <HPRO-IP> should be replaced with the IP address of your Home Pro retrieved from the Octopus Energy R&D labs app.
5. When prompted, use the password 'cad_dev'

The first time an ssh connection is made to the Home Pro it will take a couple of minutes as the VSCode SSH Server is downloaded to the Home Pro container for subsequent use.

The file system structure from root base directory is:

startup.sh
Octave_PWM/
Octave_I2C/
Octave_GPIO/
Octave_SPI/
Octave_Energy/
Octave_Screen/

The startup.sh is a script that is run at container launch while the Octave_* are directories for APIs of the different interfaces.

my-energy-app/
├── app.json           # App metadata and configuration
├── index.js           # Main entry point
├── package.json       # Dependencies
├── README.md          # Documentation
├── assets/            # App assets (icons, etc.)
│   ├── icon-48.png
│   ├── icon-96.png
│   └── icon-192.png
└── lib/               # Additional code modules
    ├── api.js
    └── utils.js

# Test in the emulator
home-pro-cli emulate

# Deploy to your device
home-pro-cli deploy --device=living-room

For comprehensive API documentation with detailed code examples and implementation guides, please refer to our dedicated API Reference page.