Downloads
The Windows app is one zip with the exe and the files it needs beside it. The Arduino library is a second zip. Arduino IDE installs that zip from Sketch → Include Library → Add .ZIP Library…
Windows app
This zip contains boxio_windows.exe, flutter_windows.dll, and the data folder. Extract the whole folder, then run the exe from inside it.
- Download
boxio-windows.zip. - Right-click the zip and choose Extract All. A folder you can keep, such as
Documents\Box IO, is a good place. - Open the extracted
boxio-windowsfolder and double-clickboxio_windows.exe. - Leave
flutter_windows.dlland thedatafolder next to the exe. The app loads those files from that same folder. Copying only the exe will not start the app. - Enter the address of your Box IO server and sign in. The server install is on the Docker Install page.
Windows may show a SmartScreen prompt because this build is not signed with a paid certificate. When you downloaded the zip from this site, choose More info, then Run anyway.
Arduino library
BoxIO.zip is the library for Arduino IDE. The zip already has one BoxIO folder at the top, with library.properties, src, and the examples inside it. Leave the file zipped. Add .ZIP Library is what unpacks it.
Install the zip in Arduino IDE
These steps are the same in Arduino IDE 2 and Arduino IDE 1.8.
- Download
BoxIO.zip. Remember the folder it saved to. Downloads is the usual place. Do not extract it. - Open the Arduino IDE.
- Choose Sketch → Include Library → Add .ZIP Library…
- Select
BoxIO.zipand click Open. - Wait until the status bar says the library was added. The IDE copies it into the sketchbook libraries folder. On Windows that folder is
Documents\Arduino\libraries\BoxIO. On macOS it isDocuments/Arduino/libraries/BoxIO. On Linux it isArduino/libraries/BoxIOorDocuments/Arduino/libraries/BoxIOin your home folder. - Open File → Examples → BoxIO. If that menu is missing, close the IDE and open it again.
- Open an example, such as LedButton or WidgetLab. Put your device key in
BOXIO_AUTHand set the host to the Box IO computer. The port is5923. Upload the sketch. The calls are on the Arduino functions page.
If Add .ZIP Library will not take the file
- Use the
BoxIO.zipfrom this page. A zip of the files inside the library, with noBoxIOfolder at the top, is not a library the IDE can install. - If
Documents/Arduino/librariesalready has aBoxIOfolder, move that folder out, then run Add .ZIP Library again. - You can also extract the zip yourself and move the
BoxIOfolder into that libraries folder, then restart the IDE. The folder name staysBoxIO.
What else the sketches need
- ESP32 sketches need the ESP32 boards package from Boards Manager. Those sketches include
BoxIOEsp32.h. - A W5500 Ethernet sketch needs the Ethernet library by Arduino, from Library Manager.
- Teensy 4.1 needs QNEthernet by Shawn Silverman, from Library Manager. This zip does not include that library. Open File → Examples → BoxIO → Teensy41 after both libraries are installed.