board_canaries

Code to run on every board, to run canary tests.
Nightly unit test logs for all boards except the orange pi are located at /var/log/canary_tests.log. These logs are then analyzed and analysis logs can be found at /var/log/canary_analysis.log. The orange pi's logs are located at /home/orangepi/board_canaries/. Test failures are reported to Slack.

To set up a new board:

• Create a new robot, likely in the viam-hardware-testing org, in the "Board Canaries" location.
• Add a board to that robot, whose type matches your physical hardware.
• In the CONFIGURE -> Builder tab click the + sign and select Network. Then set the bind address to port 9090 in Network.
• Install Viam on the physical board, per the Setup tab in the robot you just created. However, put the config file in /etc/viam-canary.json instead of /etc/viam.json.
• Jump together 2 pins on your board. Ideally, one of them (the "output" pin) will also have hardware PWM enabled.
  • If you have a board whose GPIO pins cannot also do hardware PWM but you want to test hardware PWM separately, jump together a second set of pins. One set will be to test GPIO input and output, and the other will test hardware PWM output and digital interrupt input.
  • Also jump together 2 more gpio pins to test software PWM.
• Clone this repo onto the board.
• Run sudo ./install.sh
• Follow the instructions printed at the end of that script:
  • Copy canary_config.example.py into canary_config.py. Edit it to use the correct address and API key, and the pins on the board you jumped together in the earlier step.
  • Copy slack_reporter_config.example.py into slack_reporter_config.py. Edit it so it can report to the correct Slack channel. To check that you set it up right, try running ./check_slack_connectivity.py: if you did it right, you'll get a message in that Slack channel.
  • Back in app.viam.com, find the CONNECT tab. Select Python under Code Sample and enable Include API Key. Then copy the opts section and the machine address and paste them into the monitor_config.py of the Pi5 canary.
• Update the "Team Hardware" wiki with the login info.