File Coverage

blib/lib/Net/GPSD3/Return/DEVICE.pm
Criterion Covered Total %
statement 19 21 90.4
branch 1 4 25.0
condition n/a
subroutine 13 15 86.6
pod 12 12 100.0
total 45 52 86.5


line stmt bran cond sub pod time code
1             package Net::GPSD3::Return::DEVICE;
2 3     3   1792 use strict;
  3         7  
  3         88  
3 3     3   13 use warnings;
  3         5  
  3         82  
4 3     3   13 use base qw{Net::GPSD3::Return::Unknown};
  3         6  
  3         999  
5              
6             our $VERSION='0.14';
7              
8             =head1 NAME
9              
10             Net::GPSD3::Return::DEVICE - Net::GPSD3 Return DEVICE Object
11              
12             =head1 SYNOPSIS
13              
14             =head1 DESCRIPTION
15              
16             Provides a Perl object interface to the DEVICE object returned by the GPSD daemon.
17              
18             =head1 METHODS
19              
20             =head2 class
21              
22             Returns the object class
23              
24             =head2 string
25              
26             Returns the JSON string
27              
28             =head2 parent
29              
30             Return the parent L object
31              
32             =head2 device
33              
34             Name the device for which the control bits are being reported, or for which they are to be applied. This attribute may be omitted only when there is exactly one subscribed channel.
35              
36             =cut
37              
38 0     0 1 0 sub device {shift->{"device"}};
39              
40             =head2 driver
41              
42             GPSD's name for the device driver type. Won't be reported before gpsd has seen identifiable packets from the device.
43              
44             =cut
45              
46 2 50   2 1 12 sub driver {shift->{"driver"}||'none'};
47              
48             =head2 subtype
49              
50             Whatever version information the device returned.
51              
52             =cut
53              
54 0 0   0 1 0 sub subtype {shift->{"subtype"}||'none'};
55              
56             =head2 path
57              
58             =cut
59              
60 2     2 1 8 sub path {shift->{"path"}};
61              
62             =head2 native
63              
64             0 means NMEA mode and 1 means alternate mode (binary if it has one, for SiRF and Evermore chipsets in particular). Attempting to set this mode on a non-GPS device will yield an error.
65              
66             =cut
67              
68 2     2 1 8 sub native {shift->{"native"}};
69              
70             =head2 activated
71              
72             Time the device was activated, or 0 if it is being closed.
73              
74             Note: I expect this to change to either a boolean or a timestamp in the 3.5 protocol.
75              
76             =cut
77              
78 2     2 1 9 sub activated {shift->{"activated"}};
79              
80             =head2 cycle
81              
82             Device cycle time in seconds.
83              
84             =cut
85              
86 2     2 1 9 sub cycle {shift->{"cycle"}};
87              
88             =head2 mincycle
89              
90             Device minimum cycle time in seconds. Reported from ?CONFIGDEV when (and only when) the rate is switchable. It is read-only and not settable.
91              
92             =cut
93              
94 2     2 1 13 sub mincycle {shift->{"mincycle"}};
95              
96             =head2 flags
97              
98             Bit vector of property flags. Currently defined flags are: describe packet types seen so far (GPS, RTCM2, RTCM3, AIS). Won't be reported if empty, e.g. before gpsd has seen identifiable packets from the device.
99              
100             =cut
101              
102 2     2 1 11 sub flags {shift->{"flags"}};
103              
104             =head2 bps
105              
106             Device speed in bits per second.
107              
108             =cut
109              
110 2     2 1 8 sub bps {shift->{"bps"}};
111              
112             =head2 parity
113              
114             N, O or E for no parity, odd, or even.
115              
116             =cut
117              
118 2     2 1 9 sub parity {shift->{"parity"}};
119              
120             =head2 stopbits
121              
122             Stop bits (1 or 2).
123              
124             =cut
125              
126 2     2 1 8 sub stopbits {shift->{"stopbits"}};
127              
128             =head1 BUGS
129              
130             Log on RT and Send to gpsd-dev email list
131              
132             =head1 SUPPORT
133              
134             DavisNetworks.com supports all Perl applications including this package.
135              
136             Try gpsd-dev email list
137              
138             =head1 AUTHOR
139              
140             Michael R. Davis
141             CPAN ID: MRDVT
142             STOP, LLC
143             domain=>michaelrdavis,tld=>com,account=>perl
144             http://www.stopllc.com/
145              
146             =head1 COPYRIGHT
147              
148             This program is free software licensed under the...
149              
150             The BSD License
151              
152             The full text of the license can be found in the LICENSE file included with this module.
153              
154             =head1 SEE ALSO
155              
156             L
157              
158             =cut
159              
160             1;