Skip to content

Commit 9be424f

Browse files
committed
Add documentation for python-can plugin
1 parent 56b7e4a commit 9be424f

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ Build the Visual Studio solution in the Windows folder. I use Visual Studio Comm
4242

4343
The solution contains code for a demo application that sends and dumps CAN traffic.
4444

45+
### Python
46+
47+
A [python-can](https://python-can.readthedocs.io/en/stable/) plugin is available. See [here](Windows/python/README.md) for details.
48+
4549
## Linux SocketCAN driver
4650

4751
To build the Linux kernel module, please follow [these instructions](https://github.com/jgressmann/supercan-linux).

Windows/python/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# SuperCAN plugin for python-can
1+
# SuperCAN plugin for [python-can](https://python-can.readthedocs.io/en/stable/)
22

33
This plugin is required on Windows to get access to SuperCAN devices from Python. On Linux, simply use `can.Bus(interface='socketcan', ...)`.
44

@@ -15,7 +15,7 @@ Open a native command prompt.
1515

1616
```sh
1717
pacman -S mingw-w64-x86_64-toolchain mingw64/mingw-w64-x86_64-python-pip
18-
```
18+
```
1919

2020
### Common Steps
2121

@@ -33,6 +33,7 @@ Open a native command prompt.
3333

3434
1. Ensure your device is upgraded to firmware version 0.6.0 or better.
3535
2. Optionally, register the COM server (`supercan_srv64.exe`) for shared channel access. If you used the installer, this step is already done. Otherwise, from an _admin_ console, run
36+
3637
```console
3738
supercan_srv64.exe /RegServer
3839
```

0 commit comments

Comments
 (0)