File: can_bridge.1

package info (click to toggle)
python-can 4.6.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,428 kB
  • sloc: python: 27,154; makefile: 31; sh: 16
file content (97 lines) | stat: -rw-r--r-- 4,089 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH CAN_BRIDGE "1" "October 2025" "can_bridge 4.6.1" "User Commands"
.SH NAME
can_bridge \- bridge two CAN buses
.SH DESCRIPTION
usage: can_bridge [\-h] [\-\-bus1\-channel CHANNEL]
.IP
[\-\-bus1\-interface INTERFACE]
[\-\-bus1\-bitrate BITRATE] [\-\-bus1\-fd]
[\-\-bus1\-data\-bitrate DATA_BITRATE]
[\-\-bus1\-timing TIMING_ARG [TIMING_ARG ...]]
[\-\-bus1\-bus\-kwargs BUS_KWARG [BUS_KWARG ...]]
[\-\-bus2\-channel CHANNEL]
[\-\-bus2\-interface INTERFACE]
[\-\-bus2\-bitrate BITRATE] [\-\-bus2\-fd]
[\-\-bus2\-data\-bitrate DATA_BITRATE]
[\-\-bus2\-timing TIMING_ARG [TIMING_ARG ...]]
[\-\-bus2\-bus\-kwargs BUS_KWARG [BUS_KWARG ...]]
.PP
Bridge two CAN buses. Both can buses will be connected so that messages from
bus1 will be sent on bus2 and messages from bus2 will be sent to bus1.
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.SS "Bus 1 arguments:"
.TP
\fB\-\-bus1\-channel\fR CHANNEL
Most backend interfaces require some sort of channel.
For example with the serial interface the channel
might be a rfcomm device: "/dev/rfcomm0". With the
socketcan interface valid channel examples include:
"can0", "vcan0".
.TP
\fB\-\-bus1\-interface\fR {canalystii,cantact,etas,gs_usb,iscan,ixxat,kvaser,neousys,neovi,nican,nixnet,pcan,robotell,seeedstudio,serial,slcan,socketcan,socketcand,systec,udp_multicast,usb2can,vector,virtual}
Specify the backend CAN interface to use. If left
blank, fall back to reading from configuration files.
.TP
\fB\-\-bus1\-bitrate\fR BITRATE
Bitrate to use for the CAN bus.
.TP
\fB\-\-bus1\-fd\fR
Activate CAN\-FD support
.TP
\fB\-\-bus1\-data\-bitrate\fR DATA_BITRATE
Bitrate to use for the data phase in case of CAN\-FD.
.TP
\fB\-\-bus1\-timing\fR TIMING_ARG [TIMING_ARG ...]
Configure bit rate and bit timing. For example, use
`\-\-timing f_clock=8_000_000 tseg1=5 tseg2=2 sjw=2
brp=2 nof_samples=1` for classical CAN or `\-\-timing
f_clock=80_000_000 nom_tseg1=119 nom_tseg2=40
nom_sjw=40 nom_brp=1 data_tseg1=29 data_tseg2=10
data_sjw=10 data_brp=1` for CAN FD. Check the pythoncan documentation to verify whether your CAN interface
supports the `timing` argument.
.TP
\fB\-\-bus1\-bus\-kwargs\fR BUS_KWARG [BUS_KWARG ...]
Pass keyword arguments down to the instantiation of
the bus class. For example, `\-i vector \fB\-c\fR 1 \fB\-\-buskwargs\fR app_name=MyCanApp serial=1234` is equivalent to
opening the bus with `can.Bus('vector', channel=1,
app_name='MyCanApp', serial=1234)
.SS "Bus 2 arguments:"
.TP
\fB\-\-bus2\-channel\fR CHANNEL
Most backend interfaces require some sort of channel.
For example with the serial interface the channel
might be a rfcomm device: "/dev/rfcomm0". With the
socketcan interface valid channel examples include:
"can0", "vcan0".
.TP
\fB\-\-bus2\-interface\fR {canalystii,cantact,etas,gs_usb,iscan,ixxat,kvaser,neousys,neovi,nican,nixnet,pcan,robotell,seeedstudio,serial,slcan,socketcan,socketcand,systec,udp_multicast,usb2can,vector,virtual}
Specify the backend CAN interface to use. If left
blank, fall back to reading from configuration files.
.TP
\fB\-\-bus2\-bitrate\fR BITRATE
Bitrate to use for the CAN bus.
.TP
\fB\-\-bus2\-fd\fR
Activate CAN\-FD support
.TP
\fB\-\-bus2\-data\-bitrate\fR DATA_BITRATE
Bitrate to use for the data phase in case of CAN\-FD.
.TP
\fB\-\-bus2\-timing\fR TIMING_ARG [TIMING_ARG ...]
Configure bit rate and bit timing. For example, use
`\-\-timing f_clock=8_000_000 tseg1=5 tseg2=2 sjw=2
brp=2 nof_samples=1` for classical CAN or `\-\-timing
f_clock=80_000_000 nom_tseg1=119 nom_tseg2=40
nom_sjw=40 nom_brp=1 data_tseg1=29 data_tseg2=10
data_sjw=10 data_brp=1` for CAN FD. Check the pythoncan documentation to verify whether your CAN interface
supports the `timing` argument.
.TP
\fB\-\-bus2\-bus\-kwargs\fR BUS_KWARG [BUS_KWARG ...]
Pass keyword arguments down to the instantiation of
the bus class. For example, `\-i vector \fB\-c\fR 1 \fB\-\-buskwargs\fR app_name=MyCanApp serial=1234` is equivalent to
opening the bus with `can.Bus('vector', channel=1,
app_name='MyCanApp', serial=1234)