Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'next' of https://git.pnnl.gov/hone/sensor/linux/staging …
…into next
- Loading branch information
Showing
1 changed file
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
|
||
INTRODUCTION | ||
|
||
honeread is an example reader/logger for the Hone Linux sensor. It | ||
demonstrates reading from /dev/hone using both read(2)/write(2) and splice(2) | ||
as well as using ioctl(3p) to set the snaplen and to notify the sensor to | ||
terminate the file. honeread can also be used to read /dev/honet. | ||
|
||
|
||
DOWNLOADING | ||
|
||
You can get the source code by cloning the repository or by downloading a zip | ||
file from Github: | ||
|
||
https://github.com/HoneProject/Linux-Sensor | ||
|
||
|
||
BUILDING | ||
|
||
From within the Hone sensor source tree, just run make. If building out of | ||
tree, set HONEDIR to the full path where honeevent.h is found. | ||
|
||
|
||
USAGE | ||
|
||
After building, run `./honeread --help` for advanced usage. Basic usage is to | ||
run honeread with one argument, the file where the output should be written. | ||
The output will be written to standard out (stdout) by default, which is | ||
probably not a great idea when reading from /dev/hone since it is a binary | ||
file, but it allows one to easily pipe the output into another program. | ||
|
||
The Hone sensor kernel driver must be loaded before attempting to log with | ||
honeread as it attaches to the device implemented in the driver. | ||
|
||
|
||
LICENSE | ||
|
||
honeread is covered under the same license as the sensor, GPL version 2. | ||
|
||
|
||
BUGS | ||
|
||
Please use the Github issue tracker to report bugs: | ||
|
||
https://github.com/HoneProject/Linux-Sensor/issues | ||
|