What commands are available in the Timebeat CLI

Base Tree Commands:

set
show

(if in doubt, use the tab key to view options)

Full Command Tree:

├── set
│   ├── ocptap
│   │   ├── irig_b_mode
│   │   ├── sma
│   │   ├── ts_window_adjust
│   │   ├── utc_tai_offset
│   ├── opentimecard
│   │   ├── sbc
│   │   │   ├── clockgen
│   │   │   │   ├── dpll
│   │   │   │   │   ├── fod
│   │   │   │   │   │   ├── freq
│   │   │   │   │   ├── pullin
│   │   │   │   ├── output
│   │   │   │   │   ├── div
│   │   │   │   │   ├── dutycyclehigh
│   │   │   │   │   │   ├── freq
│   │   │   │   ├── reset
│   │   │   ├── firmware
│   │   │   │   ├── flash
│   ├── phc
│   │   ├── device
│   │   │   ├── exts
│   │   │   ├── frequency
│   │   │   ├── pps
│   ├── ptp
│   │   ├── packet
│   │   │   ├── stats
│   │   │   │   ├── enable
│   │   │   │   ├── disable
│   │   ├── peer
│   │   │   ├── announce
│   │   │   │   ├── update
│   │   │   ├── simulator
│   ├── taas
│   │   ├── client
│   │   │   ├── add
│   │   │   ├── delete
├── show 
│   ├── clocks
│   │   ├── offset
│   ├── configuration
│   │   ├── timesources
│   ├── help
│   ├── ocptap
│   │   ├── timecards
│   ├── opentimecard
│   │   ├── sbc
│   │   │   ├── clockgen
│   │   │   │   ├── dpll
│   │   │   │   │   ├── status
│   │   │   │   ├── input
│   │   │   │   │   ├── status
│   │   │   ├── gnss
│   │   │   │   ├── sats
│   ├── phc
│   │   ├── device
│   │   ├── devices
│   ├── ptp
│   │   ├── packet
│   │   │   ├── stats
│   │   ├── peer
│   │   ├── peers
│   │   ├── sockets
│   ├── servo
│   │   ├── sources
│   ├── squared
│   │   ├── capacity
│   │   ├── clients
│   │   ├── network
│   │   ├── reservations
│   │   ├── seats
│   │   ├── servers
│   ├── startup-config
│   ├── taas
│   │   ├── clients
│   ├── version

A more detailed breakdown of some of the commands:

show startup-config

See the current running configuration with no distractions from comments or parameter suggestions.

show version

 Show the current version of Timebeat, along with the operating system and CPU architecture.

show clocks offset

Shows the offset of the individual clocks being synchronised by the incoming source. This can be a PHC and or the System clock

show help

 Shows exit message

show phc devices

 Shows the system's PTP hardware clocks.

show phc device pin

Usage: show phc device pin <interface> <pin>

 Lists more detailed information about the pins associated with a particular PTP hardware clock.  For example, when run on the timecard mini, which has eth0 as its interface, we could use the command: #show phc device pin eth0 0

Pin: 0
Name: SYNC_OUT
Function: PTP_PF_EXTTS
Channel: 0

 In this instance, pin 0 corresponds to pin 9 in block J2 of the official CM4 IO board.  PTP_PF_EXTTS (External Time Triggering Signal) shows that we intend to receive signal from the GNSS receiver.

set phc device pps

Usage: set phc device pps <interface> <pin> <index> enable|disable

 In the event that this command is run successfully, there will be no error message or feedback (as of version 1.5.2).  For instance

#set phc device pps eth0 0 0 enable

 #

You can then confirm the change by running

#show phc device pin eth0 0

Pin: 0
Name: SYNC_OUT
Function: PTP_PF_PEROUT
Channel: 0

PTP_PF_PEROUT (Periodic Output) shows that we will now emit a signal on the respective pin.

#set phc device pps eth0 0 0 disable

Pin: 0
Name: SYNC_OUT
Function: PTP_PF_NONE
Channel: 0

PTP_PF_NONE confirms the command.

set phc device extts

Usage: set phc device extts <interface> <pin> <index> enable|disable

PTP_PF_EXTTS (External Time Triggering Signal) is where we want to receive signal from the GNSS receiver.  This was our original pin state before we used the commands detailed above.  To restore the setting use:

#set phc device extts eth0 0 0 enable

set phc device frequency

Usage: set phc device frequency <interface> <frequency>|disable

Set the PTP hardware clock (in parts per billion/ppb) to a specified new frequency.

#set phc device frequency eth0

Outside of the CLI you can use the linuxptp packages, specifically ptp_ctl to check the current frequency by running ptp_ctl.

root@raspberrypi:/home/admin# phc_ctl eth0 freq
phc_ctl[4728.014]: clock frequency offset is -1346.984863ppb

show squared servers

If PTP+Squared is configured then this command will list the nodes forming the mesh network.  This does not refer to whether we send or receive time from the hosts, only their presence in the network.

Address      Status                 Peer ID

192.168.1.2 NotConnected   93Leh4DOiEj24C3nLE9fnHDnecFed2Dien4DE2OqpUn3Ddi3r
192.168.1.4 Connected         93Leh4DO...
192.168.1.7 NotConnected   93Leh4DO...

show squared clients

It shows the nodes we are currently receiving time from.

Address   |   Remote Root Distance  |  Reputation  | Score  | Active | Capabilities

192.168.1.2               8786                    0.004509                                utcsource:indirect
192.168.1.4               7519                  -1.000000                                 utcsource:indirect
192.168.1.7               8482                    0.000000                       *         utcsource:indirect

Address:  The IP address of the node in question

Remote Root Distance: The cumulative distance between the node in question and the nearest root node.

Reputation Score: Reputation scores are the concept of child nodes reporting to the parent node how the distribution of offsets observed by the child node from a specific parent node compares with offset distributions from other parent nodes (time sources)

Active:  Are we considering the time we received from this node when we steer our clock?

Capabilities: The capabilities of the node, one of the following options

utcsource:direct - the node has a direct source of UTC

utcsource:indirect - the node has received UTC from another node

hqosc:1500- the node has a high quality oscillator.  The 1500 refers to 1.5μs of drift in a 24 hour period.

show squared seats

Timebeat# show squared seats

My ID is: 16Uiu2HAkwRHRzR8bqUZH612fm8QXBFbpE3W8xpQuNzXe9g9qhTtG
My RootDistance is: 0

Time sent from other peers to this peer:
Current server peer(s): 0
Unfilled client seats: 0
Max seats: 0

Time sent from this peer to other peers:
Current client peer(s): 3
Unfilled server seats: 1
Max seats: 4

show squared capacity

Which PTP+Squared nodes have the capacity to give time to other nodes?

Address:  The IP address of the node

Root Distance:  The cumulative distance between the node and the nearest root node.

Seats Available:  How many more nodes can the shown node give time to?

Peer ID: Unique identifier for the node

Capabilities: Where does the node's source of time originate? See "show squared clients" above.

show squared network

Timebeat# show squared network

Address            Status               Peer ID

192.168.0.2    Connected            xyza
192.168.0.3    NotConnected      xyzb
192.168.0.4    NotConnected      xyzc
192.168.0.5   NotConnected       xyzd
192.168.0.6   NotConnected       xyze
192.168.0.7   NotConnected       xyzf
192.168.0.8   Connected             xyzg
192.168.0.9   NotConnected       xyzh
192.168.0.10 Connected             xyzi

show squared reservations

Reservation allocations are groups of "seats" tied to a specific minimum preference score.  We can see for our local installation of Timebeat which allocations there are, what the preference score is and how much of this capacity is being used.

show ptp sockets

PTP uses UDP port 319 for time critical event messages and 320 for general messages. Here you can see which interfaces and ports Timebeat is listening.

Type         Socket         Interface   Port
L4 (udp)   Global                         319
L4 (udp)   Global                         320
L4 (udp)   IfSpecific         eth0      319
L4 (udp)   IfSpecific         eth0      320  

show ptp peers

# show ptp peers

Remote IP     Domain        ErrorOfSource    Sync Int      DelayReq Int      Local Port ID      Remote Port ID

                      10                 1000000000         127           127                       {ABC}:2                 {000}:0
                      115               1000000000         127           127                       {ABC}:1024           {000}:0
                      115               1000000000         127           127                       {ABC}:1023           {000}:0
                      115               1000000000         127           127                       {ABC}:1022           {000}:0

In the instance of a PTP client receiving PTP by multicast then no Remote IP is expected.

show ptp peer subscription

usage: show ptp peer subscription <localport id> <ptp domain>

show ptp peer eos

usage: show ptp peer eos <localport id> <ptp domain>

EOS (Error Of Source): the variance of the offset distribution of the source.  Timebeat maintains a list of EOS values which facilitates path selection according to latency.  This command allows the user to see under the hood, so to speak.

show servo sources

Shows the name, the device path and the current offset of the devices steering the clock.

URI Last Offset Interface
pps:eth0/0/0:eth0 1.020867ms eth0
timecard-mini:/dev/serial0: -109.886455ms

show configuration timesources

Lists the primary and secondary sources of time as configured in timebeat.yml

Time source index: 1
protocol: ptp
use_layer2: false
domain: 10
serve_unicast: false
serve_multicast: true
server_only: true
announce_interval: 1
sync_interval: 0
delayrequest_interval: 0
profile: <none>
unicast_master_table: <empty>
priority1: 0
priority2: 0
delay_strategy:
hybrid_e2e: false
monitor_only: false

Time source index: 2
protocol: pps

Time source index: 3
protocol: timecard-mini