Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
…into next
  • Loading branch information
Brandon Carpenter committed Sep 20, 2013
2 parents f5c7c20 + 9287702 commit 902fc2c
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions logging/README
@@ -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

0 comments on commit 902fc2c

Please sign in to comment.