Get help command
Please run all CLI commands inside a shell running in the container, preferably inside a Python virtual environment. Please refer to https://github.com/botblox/botblox-manager-software for instructions on how to do this.
For help with the CLI, type
Debugging and Programming:
A word on debugging
This project is currently in its alpha stage so we expect in the short-medium term that early users of the software could have issues with the toolchain. This is expected and to some extent desired as we want to build this project with client feedback built into the early stages. Hopefully, our documentation helps with ideas that you can try to debug. If you encounter an issue with the use of the software, we would love for you to post on the GitHub repos with an issue that you would like fixed. Please describe the issue you were facing, trying to replicate all steps in the process. Furthermore, it would help if you mention your current OS as well. With that said there are a few things that you can try.
- Ensure that all connectors between the USART-to-USB converter and the pinout header on the SwitchBlox have not slipped out and that there is definitely a connection. There have been numerous occasions where we have been developing and it could’ve saved us a few minutes to just check the connection is actually present. A multimeter can help with this.
- Check the main LED on the SwitchBlox: if it flashes when you upload, then it has received the data that you have sent to it from the computer via USART. If you send data and you don’t see the main LED flash, then try again after power-cycling the board. If it still doesn’t work and the connections are all working - then potentially flash the firmware on the board again. If this fails, then report the error on the https://github.com/botblox/botblox-manager-firmware issues page and we’ll investigate further.
- If the SwitchBlox’s LED flashes, yet the logs in the shell where you execute the CLI command indicate there has been a failure, then the software hasn’t read the command coming back from the board to inform it whether the command you programmed was successful or not. This may not actually affect the functionality, it is entirely possible that the board received the commands that were sent by the computer, they were actioned and then the firmware sent a confirmation command via USART that the software never read. This most often not is due to an error in the configuration of the RX pin in the USART-to-USB converter. If that is not the issue, then please go to https://github.com/botblox/botblox-manager-firmware and create an issue describing what you did.
Establish VLAN based on the ports connected. You define which ports are part of which group. The factory default is that all ports are part of the same VLAN.