Skip to content

device_manual

Jump to bottom
Chirag Atal edited this page Oct 16, 2023 · 4 revisions

Espressif ZeroCode

If you are flashing the devices yourself from the downloaded zip, refer the Firmware Flashing section first.

Your device is now flashed and you are ready to go.

Note: This firmware has test certificates, which cannot be used for production device. When you place an order, the ZeroCode modules will have the production certificates.

Setup Code

Scan the below QR Code from any of the Matter supported phone apps to setup the device. You can also use the manual setup code.

Note: Use the QR Code in the device's respective folder if you are flashing multiple devices yourself.

qr_code

Device Setup

Here's how you can get started with using this device with any of your favourite Ecosystems:

Amazon
  • Requirements:
    • Latest Amazon Alexa app on an Android Device.
    • One of these devices already setup in your network:
      • Echo (at least 4th gen)
      • Echo Dot (at least 3rd gen)
      • Echo Show (at least 5)
      • Echo Flex
      • Echo Input
      • Echo Plus
      • Echo Pop
      • Echo Studio
  • Setup:
    • In the Alexa app, go to devices.
    • Click the + icon on the top right, and select Add Device.
    • Then scroll to the bottom and select Other. Then select Matter.
    • You will be asked if your device has a Matter logo. Select Yes.
    • Scan the QR code or enter the setup code manually.
    • The device setup should start.
    • You will be prompted to enter your network credentials.
    • In about a minute, you will be prompted to add your device to any room/group and change the device name to what you want.
    • The app should show that the device has been added successfully.
  • Control:
    • You should be able to control the device using the Alexa app.
    • You can also use Alexa and use voice to control your device.
Apple
  • Requirements:
    • Latest Apple Home app on an Apple device (running at least iOS/iPadOS 16.1).
    • One of these devices already setup in your network:
      • Apple Homepod (running at least tvOS 16.1)
      • Apple TV (running at least tvOS 16.1)
  • Setup:
    • Open the Apple Home app.
    • Click the + icon on the top right, and select Add Accessory.
    • Scan the QR code or enter the setup code manually.
    • The device setup should start.
    • You might get a prompt that you are adding an uncertified accessory, click on add anyway.
    • In about a minute, you will be prompted to add your device to any room and change the device name to what you want.
    • You might be asked for some additional device setup, which you can skip or do them later.
    • The app should show that the device has been added successfully.
  • Control:
    • You should be able to control the device using the Apple Home app.
    • You can also use Siri and use voice to control your device.
Google
  • Requirements:
    • Latest Google Home app on an Android Device (running at least Android 8.1).
    • One of these devices already setup in your network:
      • Google Home (does not have Thread support)
      • Google Home Mini (does not have Thread support)
      • Google Nest Audio (does not have Thread support)
      • Google Nest Hub (does not have Thread support)
      • Google Nest Hub (2nd gen)
      • Google Nest Hub Max
      • Google Nest Mini (does not have Thread support)
      • Nest WiFi Pro
    • Since the device has test certificates, your Google account needs to be registered to be able to setup the device. You can share your Google email ID with us, and we can enable your account.
  • Setup:
    • In the Google Home app, go to devices.
    • Click the + Add button, and select New device.
    • Select your home then the app will start looking for nearby devices.
    • Select your device from the list, then scan the QR code or enter the setup code manually.
    • The device setup should start.
    • In about a minute, the app should show that the device has been added successfully.
    • You can now add your device to any room and change the device name to what you want.
  • Control:
    • You should be able to control the device using the Google Home app.
    • You can also use Google Assistant and use voice to control your device.
ESP RainMaker
  • Requirements:
    • Latest ESP RainMaker app on an Apple Device (running at least iOS/iPadOS 16.4).
  • Setup:
    • Open the ESP RainMaker app and select/create a group.
    • Click the + icon on top right.
    • Scan the QR code.
    • You might be asked to scan the QR code again or enter the setup code manually.
    • The device setup should start.
    • You might get a prompt that you are adding an uncertified accessory, click on add anyway.
    • In about 2 minutes, the app should show that the device has been added successfully.
  • Control:
    • You should be able to control the device using the ESP RainMaker app.
Samsung
  • Requirements:
    • Latest SmartThings app on an Android Device.
    • One of these devices already setup in your network:
      • Aeotec Smart Home Hub
      • SmartThings 2015 Hub (does not have Thread support)
      • SmartThings 2018 Hub
  • Setup:
    • In the SmartThings app, go to devices.
    • Click the + icon, and select QR code.
    • Scan the QR code or enter the setup code manually.
    • The device setup should start.
    • You might get a prompt that this isn't a Matter certified device, click on continue.
    • You might also be prompted to enter your network credentials.
    • In about a minute, you will be prompted to add your device to any room and change the device name to what you want.
    • The app should show that the device has been added successfully.
  • Control:
    • You should be able to control the device using the SmartThings app.

Device Functionality

Indicators

  • Setup mode: LED shows a breathing pattern continuously, about 2 seconds per cycle, with green color.
  • Setup started: LED shows a breathing pattern continuously, about 1 second per cycle, with yellow color.
  • Setup complete: LED shows the default state of the device and stops any ongoing patterns.
  • Setup failed: LED remains solid, with red color.

Factory Reset

  • Press and hold the input button for about 5000 milliseconds. Then release the button to factory reset the device.
  • The device will then reboot and enter setup mode.

Test Mode

  • Test complete: Mark test mode as complete. The device will not enter test mode ever again.
    • ssid: test_complete
  • BLE MAC: Broadcast the MAC address over BLE.
    • ssid: test_ble_mac
  • Socket 1: All sockets turn on and off, 3 times.
    • ssid: test_socket_1
  • Socket 2: All sockets change the level from 0 to 100 and back to 0.
    • ssid: test_socket_2
Firmware from zip

Firmware Flashing

If you are flashing the device firmware yourself from the downloaded zip, refer the the appropriate section below for the flashing instructions. You can either use esptool in your terminal/power_shell or Flash download tool.

Using esptool on command line (MacOS, Linux, Windows)

Pre-requisites

Install esptool

  • Refer the installation
  • Open terminal/power_shell
  • Run: pip install esptool
  • Connect your device and note down the port
  • You might have to provide the port in the below commands by passing -p <port>

Flashing

Erase the flash first

  • Run: esptool.py erase_flash

Flash the firmware

  • 0x0: common_binaries/*_merged.bin
  • Run: esptool.py write_flash 0x0 common_binaries/*_merged.bin

Flash other required files

  • 0xD000: devices/<number>/esp_secure_cert.bin
  • 0x1F2000: devices/<number>/fctry.bin
  • Run: esptool.py write_flash 0xD000 devices/1/esp_secure_cert.bin 0x1F2000 devices/1/fctry.bin

Your device is now ready. You can go to the Setup Code section to continue setting up your device.

Using Flash Download Tool (Windows)

Pre-requisites

Install the Flash Download Tool

  • Download the tool
  • Extract (unzip) the files and refer the pdf doc/
  • Run the flash_download_tool
  • Select your chip and proceed
  • Connect your device and select the port in COM

Flashing

Erase the flash first

  • Click on erase

Flash the firmware

  • 0x0: common_binaries/*_merged.bin
  • Browse the file and enter its location and click on start

Flash other required files

  • 0xD000: devices/<number>/esp_secure_cert.bin
  • 0x1F2000: devices/<number>/fctry.bin
  • Browse the files, enter their locations and click on start

Your device is now ready. You can go to the Setup Code section to continue setting up your device.

Clone this wiki locally