vagrant@vagrant:~$ vagrant@vagrant:~$ curl -H "X-Boxee-Auth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6ImJmNzY2NTkxLTU0YTgtNGY1Yy1iN2FlLTY4OWJlODQ2YmRkZCIsImV4cCI6MTY2MTU2NzY0OSwiaXNzIjoiYm94ZWUtc2VydmljZSJ9.Aygr19ECRBB_nfkESThQ6RLZy5o29Gl-_i5SCAkBys8" -H "Content-Type: application/json" https://api.box-ee.com/api/v1/device/list | jq Q6RLZy5o29Gl-_i5SCAkBys8" -H "Content-Type: application/json" https://api.box-ee.com/api/v1/device/list | jq % % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0100 57 100 57 0 0 195 0 --:--:-- --:--:-- --:--:-- 195{ "count": 0, "devices": [], "msg": "found", "status_code": 200}vagrant@vagrant:~$ e vagrant@vagrant:~$ ex vagrant@vagrant:~$ exi vagrant@vagrant:~$ exit vagrant@vagrant:~$ exitexit
Box-ee Documentation
Back to homepage
  1. BOX-EE Documentation
  2. /
  3. Box-ee IOT
  4. /
  5. Getting Started

Getting Started

BOX-EE IOT is comprised of two main parts.

  1. physical connections
  2. micropython code

The recommended steps to build out your BOX-EE is to

  1. Order the desired materials from the BOM
  2. Physically build the connections on a breadboard
  3. Install Micropython and tools needed to flash the ESP32
  4. Download the latest BOX-EE IOT code from github
  5. Set your desired configurations
  6. Flash the esp32 with BOX-EE code
  7. Enjoy safe packages and deliveries

The microprocessor used for the project is an esp32 flashed with micropython. This documentation will briefly touch on getting an esp32 ready for micropython but for more in-depth details, check out the official micropython docs here https://docs.micropython.org/en/latest/esp32/tutorial/intro.html#esp32-intro.

Requirements

BOM (Bill of Materials)

  • Prices are round estimates as of this writing 12/02/2022.
  • The quantity below is the quantity that it is shipped with but only 1 of each item is needed
  • Check the Optional Section to understand which Optional Item you need.
Item Optional Qty Price Link
ESP32 Starter Kit 1 26 USD Amazon
Solenoid Lock 1 15 USD Amazon
Barcode Scanner X 1 35 USD Amazon
CH559 USB Host X 1 9.50 USD Tindie
Pin Pad X 2 10.99 USD Amazon
Lock Relay Module 5 8 USD Amazon
Hard Reset Button 100 5 USD Amazon
PIR Motion Sensor 3 8 USD Amazon
RC Battery Charger 1 20 USD Amazon
12V 2000 mAh RC Battery 1 21 USD Amazon
Male Female Battery Cords X 2 10 USD Amazon
Raspberry Pi UPS Power 1 20 USD Amazon
3.7 V Rechargable Battery 2 27 USD Amazon
Solar Panel Charger X 1 24 USD Amazon
Husky Utility Box X 1 99 USD Home Depot

Deciding Optional Items

There is some flexibility when choosing which items you want to purchase and it is entirely up to you how you want to design your build. Look at the following table to see which kind of trade off you prefer.

From the optional items, you will need at least a barcode scanner OR a pinpad. You can certainly have both but having at least one is a requirement.

The rest of the tutorial will contain ALL optional items as part of the assembly.

If you want to scan in your packages with a barcode scanner instead of typing in a Pin Pad, you will need the following items

  • Barcode Scanner
  • CH559 USB Host

If you want to only open your box with a 4 digit key and not use a barcode, you will need the following items

  • Pin Pad

If you want to have your box-ee be solar powered, you will need the following items

  • Solar Panel Charger

The Box-ee project encourages users to let their creativity shine when making their BOX-EE. For this tutorial, we used a Husky brand utility box from Home Depot for a few reasons. It’s tough, durable, and easily modifiable directly off the shelf. If this style and size is something that works for you then you will need the following items.

  • Husky Utility Box

Next section