1GPSINIT(8)                    GPSD Documentation                    GPSINIT(8)
2
3
4

NAME

6       gpsinit - initialize CAN kernel modules for GPSD
7

SYNOPSIS

9       gpsinit [-n control] [-s speed] module_name [interface_name]
10
11       gpsinit -h
12
13       gpsinit -V
14

DESCRIPTION

16       gpsinit initializes whatever kernel-level modules are needed to enable
17       special non-serial hardware to communicate with a gpsd instance. Note:
18       it will need root permissions to load modules and perform other special
19       operations, such as changing kernel-interface baudrates.
20
21       At present, all modes of this tool are concerned with setting up
22       kernel-level interfaces to hardware on a CAN (Control Area Network)
23       speaking NMEA2000.
24
25       The program accepts the following options:
26
27       -h
28           Display a brief help text.
29
30       -n
31           Set the CAN network number. The default is 0.
32
33       -s
34           Set the baudrate to be used to communicate over the serial line to
35           the CAN hardware. The default is 38400 baud.
36
37       -V
38           Display the version of gpsinit.
39
40       The parameter module_name is mandatory. The socket CAN driver module
41       module_name.ko will be loaded. gpsinit recognize the following module
42       names:
43
44       plx_pci, esd_usb2, vcan, slcan
45           The parameter interface_name and -s speed can used here.
46
47       beaglebone
48           The dcan module needed for the beaglebone is part of the Linux
49           kernel, so no module is loaded in this case.
50
51       The parameter interface_name is needed for slcan hardware only. It
52       gives the name of the serial device to which the SL CAN hardware is
53       connected. The default is /dev/ttyUSB0.
54

EXAMPLES

56       All the following examples probably need to be run as root.
57
58       gpsinit plx_pci
59           Attempt to load the module plx_pci and initialize net 0 for the
60           connection to a NMEA2000 network. It will set the baudrate to
61           250kBits.
62
63       gpsinit -n 1 plx_pci
64           As above, but use net 1.
65
66       gpsinit -s 38400 slcan /dev/ttyUSB0
67           Attempt to load the module slcan and talk to the hardware at 38400
68           baud connected to port /dev/ttyUSB0.
69
70       gpsinit -h
71           Display a brief help message.
72
73       gpsinit -v
74           Display the version of gpsinit.
75

RETURN VALUES

77       0
78           on success.
79
80       1
81           on failure
82

SEE ALSO

84       gpsd(8), gps(1)
85

RESOURCES

87       Project web site: https://gpsd.io/
88

COPYING

90       This file is Copyright 2013 by the GPSD project
91       SPDX-License-Identifier: BSD-2-clause
92

AUTHOR

94       Reinhard Arlt
95
96
97
98GPSD, Version 3.25                2023-01-10                        GPSINIT(8)