Update: 11 Dec 2021: READ THIS WHOLE THREAD BEFORE BUYING THESE THINGS!! They no longer work as described in these first posts.
These devices are relatively inexpensive on Amazon. They work pretty well for WiFi devices, and there’s a supported HA integration. Note that Amazon prices and suppliers change. Sometimes you can pick up a 3-pack or 5-pack to get the unit cost down. These instructions are for the “No App” version, but it seems like there are lots of different models so buyer beware.
Like most such devices, these “want” to connect to the vendor’s cloud. I found I needed the BroadLink app to “unlock” the device so that HA can see it. There’s an unlock step in the HA integration, but I couldn’t get HA to see the device until I used the app to unlock it. After it’s working in HA, you can use your router’s firewall or Parental Controls option to block it from connecting to the BroadLink cloud.
These devices advertise a “No App” operation mode. This means that instead of using only the BroadLink app, you can use a cloud-to-cloud (C2C) option like Alexa, Siri, etc. It also means we can use the HA integration, so everything is local, no cloud. These instructions are based on using the “No App” mode.
These instructions were developed using an Android phone and a Windows laptop. Presumably the steps would be similar with other operating systems.
This document was created using the version of the SP4M-US device available on Amazon as of December, 2020, along with the current versions of the BroadLink app, HA and Android as of that date.
Is a BroadLink SP4M-US Smart Plug right for me?
Pros:
- Cost
- Availability
- Ease of configuration
- Supported HA integration using local control
- Can be manually controlled (power button on the device)
- Uses WiFi, no additional networks required
Cons:
- Requires vendor cloud for setup
- Requires good WiFi connectivity at the location of use
- Does not offer power monitoring or dimmer functions. Just on/off.
- Device is limited to a 10 Amp load. Things like electric heaters and air conditioners will not work safely
- The form factor may block other outlets on a power strip.
Installation Instructions
1) Install the BroadLink app
Oddly enough, the app is called the “BroadLink Universal TV Remote” in the Google Play app store.
https://play.google.com/store/apps/details?id=cn.com.broadlink.econtrol.international
On the Apple app store it’s called “BroadLink Super App.”
BroadLink on the App Store
When you first open the app, you will be prompted to create an account (no charge) using an e-mail address.
This can be a throw-away address, especially if you don’t want BroadLink knowing your “real” address for future spam.
2) Plug in the SP4M-US device
- Wait for 4-flash pattern
Note: to reset an existing device, press and hold the power for 5 seconds, but less than 10 seconds.
A 10-second press starts a different configuration mode (fast flash). We want the “No App” mode.
3) Obtain the BroadLink device’s MAC address
(This is how I did it. There are other ways to obtain the MAC address of the device.)
(Too bad BroadLink doesn’t print the MAC address on the device like some other vendors do.)
- On a Windows laptop, connect to the WiFi access point named “Broadlink_WiFi_Device.”
- If any “log on” pages pop up, close them. We’re not ready for that yet.
- Launch a command window (type “CMD” in the Start menu and hit enter)
- Type IPConfig and hit enter to get the Default Gateway we’re using (the BroadLink device)
Connection-specific DNS Suffix . :
IPv4 Address. . . . . . . . . . . : 192.168.10.100
Subnet Mask . . . . . . . . . . . : 255.255.255.0
Default Gateway . . . . . . . . . : 192.168.10.1
- Type ping with the BroadLink device’s address (Default Gateway) and hit enter.
ping 192.168.10.1
- Type arp -a and hit enter to display MAC (Physical) address of BroadLink device:
arp -a
Interface: 192.168.10.100 --- 0x15
Internet Address Physical Address Type
192.168.10.1 24-df-xx-xx-xx-xx dynamic
- Make a note of the MAC address (mine all started with 24-df-, but there could be others.)
- Unplug the BroadLink device
- You can now re-connect your laptop to your normal WiFi network.
4) Set up a DHCP reservation for the device on you router.
Although this step is sort of optional, it is highly recommended to always assign a consistent IP address for your IoT devices.
- On your router, add a DHCP reservation for the MAC address (24-df-whatever) which you made a note of, above.
- In this example, I’m using 192.168.1.230
5) Start the initial setup process using the BroadLink app.
- Plug in the BroadLink device
- On a cell phone, disable Mobile Data
- Connect to the “Broadlink_WiFi_Device” Network
- You will be prompted to “sign in”.
For example, on Android, tap the message “Tap here to sign in to network”
Enter the required data into the Sign in screen:
- Select your Wi-Fi network name (SSID)
- Type in your network password
- Type in the email address you registered to the app with
- Type in a Device Name. Spaces are allowed but not special characters.
- Tap “Next”
- Select “I have read the above information”
- Tap “Connect now”
- Tap “OK”
Device will restart and connect to the local router.
You can re-connect your phone to your regular WiFi and enable mobile data.
You should get an email at the address you entered above.
LED will no longer flash.
6) Unlock the device
On the cell phone:
- Re-connect phone to home WiFi if not already
- Open the BroadLink app
- Ignore the prompt to create a scene
Note: The app may “discover” other devices in your network, like TVs and Remotes.
If so, dismiss the prompt to set up new devices. (Tap “Not now.”) - Tap on the device name you entered, above
- Tap on the “…” in upper right to open the menu.
- Select “Property”
- Scroll to the bottom of the page.
- Tap on the switch button to disable “Lock device”
- Tap on “OK” to confirm unlock.
7) Verify good network communication
- On your WiFi network, ping the address you assigned in step 5, above.
(in my exmaple, 192.168.1.230) - Verify good response to ping.
8) Add the device to HA
- Log on to your Home Assistant site
- Select “Configuration” then “Integrations.”
- Click “Add Integration” in the lower right.
- Select “BroadLink” integration.
- Type in the IP address of the BroadLink device
- Click “Submit.”
- If you get a prompt to unlock the device, select “Yes, do it” and click “Submit.”
- Enter a name for this device in HA
- Expect a message indicating Success.
- You may add the device to an area in HA at this point.
When you return to the “Integrations” page, you should see the BroadLink integration and your device listed.
Note: When adding a second device, you start over at “Add Integration.” Devices can’t be added here.
Additional devices will all be listed on one BroadLink integrations section once added.
9) Verify the device works from HA
- From within the Broadlink integration in HA, click the device, then click “1 entity.”
- OR Select Configuration / Entities and search for your device.
- Click your entity name. From here you can change the icon or area in HA.
- Click the menu icon on the upper right.
- From here you can toggle the device on and off to verify operation.
10) Block the device from accessing the BroadLink cloud (Optional)
Once set up, the device can be monitored and controlled locally by HA.
Assuming you’ve set up HA to be accessible remotely, you can monitor and control it from anywhere.
Many HA users strive for a “local control” model.
If you’re interested in doing this, or concerned about privacy, you can block the device from accessing the internet once it’s been set up.
Use your router’s Parental Controls or Firewall rules to block this MAC address from accessing the WAN.
Note that if you allow access, you can also use the BroadLink app to control your device away from home as well as a C2C solution like Alexa, Siri, etc.
Setting up those options is beyond the scope of this document, but explained in the documentation which came with the device and at the BroadLink web site.