Serial Monitor Cli

Sending JSON commands

To send commands to the serial device you will write them to the console. The CLI expects command in the format below:

{"cmd": "write", "payload": "hello world"} {"cmd": "close"}

The payload field is only required for the write command.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Setting Up Dev Environment

• Create Python 3.8 Virtual Environment

   python -m venv ./.venv

• Activate environment and install dependecies

   .venv\Script\Activate
   pip install -r requirements.txt

Dev Dependecies

• A device that can connect to a serial port (e.g. Arduino Uno)
• Sample Arduino Code for test device:

  int i = 0;
  
  void setup() {
      Serial.begin(9600);
  }
  
  void loop() {
      Serial.println(i);
      i++;
      delay(1000);
  }

Setting up the debugger

1. Connect your test device to you computer
2. Run python main.py --list-ports to find which port your device is connected to
3. Open launch.json in .vscode
4. Edit args to match the current port:

   "args": ["open", "{your-port-here}", "-b 9600"]

5. Press F5 to start debugging

Building the Code

pyinstaller .\src\main.py --onefile

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.