Skip to content

Add some internal comments on the socketcan module #642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
felixdivo merged 4 commits into from
Jul 19, 2019
Merged

Add some internal comments on the socketcan module #642

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b1839f8
Document socketcan
felixdivo Jul 15, 2019
79615d7
Merge branch 'develop' into felixdivo-document-socketcan
felixdivo Jul 18, 2019
2b3d794
Merge branch 'develop' into felixdivo-document-socketcan
felixdivo Jul 19, 2019
89e0826
Merge branch 'develop' into felixdivo-document-socketcan
felixdivo Jul 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions can/interfaces/socketcan/socketcan.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# coding: utf-8

"""
The main module of the socketcan interface containing most user-facing classes and methods
along some internal methods.

At the end of the file the usage of the internal methods is shown.
"""

import logging
import ctypes
import ctypes.util
Expand Down Expand Up @@ -726,15 +733,14 @@ def _detect_available_configs():


if __name__ == "__main__":
# TODO move below to examples?

# Create two sockets on vcan0 to test send and receive
# This example demonstrates how to use the internal methods of this module.
# It creates two sockets on vcan0 to test sending and receiving.
#
# If you want to try it out you can do the following (possibly using sudo):
#
# modprobe vcan
# ip link add dev vcan0 type vcan
# ifconfig vcan0 up
# ip link set vcan0 up
#
log.setLevel(logging.DEBUG)

Expand Down