Skip to content

Commit 902fc2c

Browse files
author
Brandon Carpenter
committed
Merge branch 'next' of https://git.pnnl.gov/hone/sensor/linux/staging into next
2 parents f5c7c20 + 9287702 commit 902fc2c

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

logging/README

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
2+
INTRODUCTION
3+
4+
honeread is an example reader/logger for the Hone Linux sensor. It
5+
demonstrates reading from /dev/hone using both read(2)/write(2) and splice(2)
6+
as well as using ioctl(3p) to set the snaplen and to notify the sensor to
7+
terminate the file. honeread can also be used to read /dev/honet.
8+
9+
10+
DOWNLOADING
11+
12+
You can get the source code by cloning the repository or by downloading a zip
13+
file from Github:
14+
15+
https://github.com/HoneProject/Linux-Sensor
16+
17+
18+
BUILDING
19+
20+
From within the Hone sensor source tree, just run make. If building out of
21+
tree, set HONEDIR to the full path where honeevent.h is found.
22+
23+
24+
USAGE
25+
26+
After building, run `./honeread --help` for advanced usage. Basic usage is to
27+
run honeread with one argument, the file where the output should be written.
28+
The output will be written to standard out (stdout) by default, which is
29+
probably not a great idea when reading from /dev/hone since it is a binary
30+
file, but it allows one to easily pipe the output into another program.
31+
32+
The Hone sensor kernel driver must be loaded before attempting to log with
33+
honeread as it attaches to the device implemented in the driver.
34+
35+
36+
LICENSE
37+
38+
honeread is covered under the same license as the sensor, GPL version 2.
39+
40+
41+
BUGS
42+
43+
Please use the Github issue tracker to report bugs:
44+
45+
https://github.com/HoneProject/Linux-Sensor/issues
46+

0 commit comments

Comments
 (0)