Skip to content

Raspberry Pi - Smart plug control

This guide should get you started with the library allowing you to see some actions happening in relation to price.

Requirements

  • Raspberry Pi that is WIFI enabled and supports CPython, a good option is a RPI 2W Pico which you can get for around £25 online.
  • Are on either Octopus Go, Intelligent Octopus Go or Agile Octopus tariff

Initial setup

  • Connect raspberry pi to laptop
  • Connect a micro-hdmi to an external screen from the raspberry pi
  • Run setup, remembering your password
  • Connect to same WIFI your laptop is on

Setting up your application

  • Once it is finished, let the boot sequence run till you see a desktop
  • Open "Terminal"
  • Type python -v, press enter and check if you are >= 3.10 as this is needed for the package
  • Type touch run.py && touch .env
  • Be sure never to publish .env online or share it with anyone!
  • Type pip install energy-tariff-scheduler python-dotenv requests, press enter and let it run, it's okay to install globally on RPI's if you're only running the one thing
  • If you aren't, look into python virtual environments

Configuring your application

  • Go back to the desktop once this is complete, and right click .env and open with text editor

Info

  • Please refer to your smart plug app/documentation on how to get the IP address
  • Getting your account number and API key is documented here.
1
2
3
OCTO_ACC_NO=YOUR-ACC-NUMBER
OCTO_API_KEY=API_KEY
SMART_DEVICE_IP=DEVICE_IP
  • Now save the .env file
  • Now go back to the desktop and open the run.py file with your preferred editor (thawny programmer editor is a good default)
  • Copy in the below starter code for your relevant tariff

Info

Please refer to your smart plug documentation on how to get the HTTP actions for switching on and off (lines 20 & 24)

Octopus Go/Intelligent Boilerplate

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
import logging
import requests

from energy_tariff_scheduler import Price, runner
from dotenv import load_dotenv
import os

load_dotenv()

OCTO_ACC_NO = os.getenv('OCTO_ACC_NO')
OCTO_API_KEY = os.getenv('OCTO_API_KEY')
SMART_PLUG_IP = os.getenv('SMART_PLUG_IP')

logging.getLogger().setLevel(logging.DEBUG)

logging.debug("starting")

def switch_device_on_and_alert(price: Price):
    logging.info(f"Price is cheap: {price}")
    # CODE FOR YOUR SMART PLUG TO SWITCH ON

def switch_device_off_and_alert(price: Price):
    logging.info(f"Price is expensive: {price}")
    # CODE FOR YOUR SMART PLUG TO SWITCH OFF

runner.run_octopus_go_tariff_schedule(
    action_when_cheap=switch_shelly_on_and_alert,
    action_when_expensive=switch_shelly_off_and_alert,
    api_key=OCTO_API_KEY,
    account_number=OCTO_ACC_NO,
    is_intelligent=True
)

Octopus Agile Boilerplate

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
import logging
import requests

from energy_tariff_scheduler import Price, runner
from dotenv import load_dotenv
import os

load_dotenv()

OCTO_ACC_NO = os.getenv('OCTO_ACC_NO')
OCTO_API_KEY = os.getenv('OCTO_API_KEY')
SMART_PLUG_IP = os.getenv('SMART_PLUG_IP')

logging.getLogger().setLevel(logging.DEBUG)

logging.debug("starting")

def switch_device_on_and_alert(price: Price):
    logging.info(f"Price is cheap: {price}")
    # CODE FOR YOUR SMART PLUG TO SWITCH ON

def switch_device_off_and_alert(price: Price):
    logging.info(f"Price is expensive: {price}")
    # CODE FOR YOUR SMART PLUG TO SWITCH OFF

runner.run_octopus_agile_tariff_schedule(
    prices_to_include=24,
    action_when_cheap=switch_shelly_on_and_alert,
    action_when_expensive=switch_shelly_off_and_alert,
    api_key=OCTO_API_KEY,
    account_number=OCTO_ACC_NO,
)