1<?xml version="1.0" encoding="ISO-8859-1"?> 2<!-- 3This file is Copyright (c) 2010 by the GPSD project 4SPDX-License-Identifier: BSD-2-clause 5--> 6<!DOCTYPE refentry PUBLIC 7 "-//OASIS//DTD DocBook XML V4.1.2//EN" 8 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> 9<refentry id='gpsinit.8'> 10<refentryinfo><date>18 Jan 2013</date></refentryinfo> 11<refmeta> 12<refentrytitle>gpsinit</refentrytitle> 13<manvolnum>8</manvolnum> 14<refmiscinfo class="source">The GPSD Project</refmiscinfo> 15<refmiscinfo class="manual">GPSD Documentation</refmiscinfo> 16</refmeta> 17<refnamediv id='name'> 18<refname>gpsinit</refname> 19<refpurpose>initialize CAN kernel modules for GPSD</refpurpose> 20</refnamediv> 21<refsynopsisdiv id='synopsis'> 22 23<cmdsynopsis> 24 <command>gpsinit</command> 25 <arg choice='opt'>-n <replaceable>control</replaceable></arg> 26 <arg choice='opt'>-s <replaceable>speed</replaceable></arg> 27 <arg choice='plain'><replaceable>module_name</replaceable></arg> 28 <arg choice='opt'><replaceable>interface_name</replaceable></arg> 29</cmdsynopsis> 30<cmdsynopsis> 31 <command>gpsinit</command> 32 <arg choice='plain'>-h </arg> 33</cmdsynopsis> 34<cmdsynopsis> 35 <command>gpsinit</command> 36 <arg choice='plain'>-v </arg> 37</cmdsynopsis> 38</refsynopsisdiv> 39 40<refsect1 id='description'><title>DESCRIPTION</title> 41 42<para><application>gpsinit</application> initializes whatever 43kernel-level modules are needed to enable special non-serial hardware 44to communicate with a gpsd instance. Note: it will need root permissions 45to load modules and perform other special operations, such as changing 46kernel-interface baudrates.</para> 47 48<para>At present, all modes of this tool are concerned with setting up 49kernel-level interfaces to hardware on a CAN (Control Area Network) speaking 50NMEA2000.</para> 51 52<para>The program accepts the following options:</para> 53<variablelist remap='TP'> 54 55<varlistentry> 56<term>-h</term> 57<listitem> 58<para>Display a brief help text.</para> 59</listitem> 60</varlistentry> 61 62<varlistentry> 63<term>-v</term> 64<listitem> 65<para>Display the version of <application>gpsinit</application>.</para> 66</listitem> 67</varlistentry> 68 69<varlistentry> 70<term>-n</term> 71<listitem> 72<para>Set the CAN network number. The default is 0.</para> 73</listitem> 74</varlistentry> 75 76<varlistentry> 77<term>-s</term> 78<listitem> 79<para>Set the baudrate to be used to communicate over the serial line 80to the CAN hardware. The default is 38400 baud.</para> 81</listitem> 82</varlistentry> 83</variablelist> 84 85<para>The parameter <parameter>module_name</parameter> is mandatory. The 86socket CAN driver module <parameter>module_name</parameter>.ko will be 87loaded. <command>gpsinit</command> recognize the following module 88names: 89 90<variablelist> 91<varlistentry> 92<term>plx_pci</term> 93<term>esd_usb2</term> 94<term>vcan</term> 95<term>slcan</term> 96<listitem> 97<para> 98The parameter <parameter>interface_name</parameter> and <parameter>-s 99<replaceable>speed</replaceable></parameter> can used here. 100</para> 101</listitem> 102</varlistentry> 103<varlistentry><term>beaglebone</term> 104<listitem> 105<para> The dcan module needed for the beaglebone is part of the Linux kernel, 106so no module is loaded in this case.</para> 107</listitem> 108</varlistentry> 109</variablelist> 110</para> 111 112<para>The parameter <parameter>interface_name</parameter> is needed for 113slcan hardware only. It gives the name of the serial device to which the SL 114CAN hardware is connected. The default is /dev/ttyUSB0. 115</para> 116</refsect1> 117 118<refsect1 id='examples'><title>EXAMPLES</title> 119 120<variablelist> 121<varlistentry> 122<term><command>sudo gpsinit plx_pci</command></term> 123<listitem> 124<para>Attempt to load the module plx_pci and initialize net 0 for the 125connection to a NMEA2000 network. It will set the baudrate to 126250kBits.</para> 127</listitem> 128</varlistentry> 129<varlistentry> 130<term><command>sudo gpsinit -n 1 plx_pci</command></term> 131<listitem> 132<para>As above, but use net 1.</para> 133</listitem> 134</varlistentry> 135<varlistentry> 136<term><command>sudo gpsinit -s 38400 slcan /dev/ttyUSB0</command></term> 137<listitem> 138<para>Attempt to load the module slcan and talk to the hardware at 13938400 baud connected to port /dev/ttyUSB0.</para> 140</listitem> 141</varlistentry> 142 143<varlistentry> 144<term><command>gpsinit -h </command></term> 145<listitem> 146<para>Display a brief help message.</para> 147</listitem> 148</varlistentry> 149<varlistentry> 150<term><command>gpsinit -v </command></term> 151<listitem> 152<para>Display the version of gpsinit.</para> 153</listitem> 154</varlistentry> 155</variablelist> 156</refsect1> 157 158<refsect1 id='see_also'><title>SEE ALSO</title> 159<para> 160<citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, 161<citerefentry><refentrytitle>gps</refentrytitle><manvolnum>1</manvolnum></citerefentry>, 162<citerefentry><refentrytitle>libgps</refentrytitle><manvolnum>3</manvolnum></citerefentry>, 163<citerefentry><refentrytitle>libgpsmm</refentrytitle><manvolnum>3</manvolnum></citerefentry>. 164</para> 165</refsect1> 166 167<refsect1 id='maintainer'><title>AUTHOR</title> 168<para>Reinhard Arlt <email>reinhard.arlt@t-online.de</email>.</para> 169</refsect1> 170</refentry> 171