ptpmonkey

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 8 Open GitHub ↗

Code to decode and do a bit of analysis of PTP

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ptpmonkey
This is a simple cross-platform library to implement a software only Precision Time Protocol client/analyser. 
It is not intended to do full hardware syncing of the client PC but to let the user know what clocks are on the system and give 
some idea of the of the offsets and delays on the network.
It can be used to sync client clocks, however as it is a software only implementation accuracy is an order of magnitude less than a full ptp client implementation.

## Prerequisites
* PTPMonkey is written in c++ and needs a c++14 compliant compiler.
* It uses the non-boost Asio libary for networking. This can be downloaded from [GiHhub](https://github.com/chriskohlhoff/asio) or [Think-Sync](http://think-async.com/Asio/).
Alternatively the CMake project will clone the GitHub files for you in to the relevant directories.
* It uses my log library for logging which can be downloaded from [GiHhub](https://github.com/martim01/log)
Alternatively the CMake project will clone the GitHub files for you in to the relevant directories.

## Building
The simplest way to build the library is to use the CMake project.

```
cd {ptpmonkey directory}/build
cmake ..
cmake --build .
sudo cmake --build . --target install
```
This will check that the Asio library is downloaded to ``` {ptpmonkey directory}/external/asio ``` and build the libray.
It will then install it to ```/usr/local/lib/ ```

Note: It is possible that running ``` cmake .. ``` will report errors the first time, after it has downloaded the external submodules. If so running it again should make it configure correctly.

It is also possible to build the library using the provided Code::Blocks project.

### Using the library
The class ``` PtpMonkey ``` is the interface to the library. It is defined in ``` ptpmonkey.h ```

Construct a ``` PtpMonkey ``` object by passing the IP Address of the network interface you wish to use and the number of the PTP domain to monitor.

Derive one or more classes from ``` PtpEventHandler ``` to handle the events that ``` PtpMonkey ``` generates and pass it to your PtpMonkey object.

Now call ``` PtpMonkey.Run() ``` to start the monitoring/syncing in a separate thread.

```c++
#include "ptpmonkey.h"
#include "ptpeventloghandler.h"
...

PtpMonkey ptp("192.168.0.1", 0);
ptp.AddEventHandler(std::make_shared<PtpEventLogHandler>());
ptp.Run();
```

ptpmonkey

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README