[python source code]

ptp

The ptp commands module.

These commands are used in the following models: SS3706A

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

Attributes and Functions 
- ptp.domain
- ptp.ds.info
- ptp.enable
- ptp.portstate
- ptp.slavepreferred
- ptp.time()
- ptp.utcoffset

Ptp

Bases: BaseTSPCmd

The ptp command tree.

Properties and methods
  • .domain: The ptp.domain attribute.
  • .ds: The ptp.ds command tree.
  • .enable: The ptp.enable attribute.
  • .portstate: The ptp.portstate attribute.
  • .slavepreferred: The ptp.slavepreferred attribute.
  • .time(): The ptp.time() function.
  • .utcoffset: The ptp.utcoffset attribute.

domain property writable 

domain: str

Access the ptp.domain attribute.

Description
  • This attribute describes the IEEE Std 1588-2008 precision time protocol (PTP) domain.
Usage
  • Accessing this property will send the print(ptp.domain) query.
  • Setting this property to a value will send the ptp.domain = value command.
TSP Syntax 
- ptp.domain = value
- print(ptp.domain)
Raises:

ds property 

ds: PtpDs

Return the ptp.ds command tree.

Sub-properties and sub-methods
  • .info: The ptp.ds.info function.

enable property writable 

enable: str

Access the ptp.enable attribute.

Description
  • This attribute enables or disables the precision time protocol (PTP) described in IEEE-1588 on the Series 3700A.
Usage
  • Accessing this property will send the print(ptp.enable) query.
  • Setting this property to a value will send the ptp.enable = value command.
TSP Syntax 
- ptp.enable = value
- print(ptp.enable)
Raises:

portstate property 

portstate: str

Access the ptp.portstate attribute.

Description
  • This attribute is a read-only value that indicates the state of the IEEE-1588 precision time protocol (PTP).
Usage
  • Accessing this property will send the print(ptp.portstate) query.
TSP Syntax 
- print(ptp.portstate)
Info
  • state, the ptp.INITIALIZING (0) ptp.FAULTY (1) ptp.DISABLE (2) ptp.LISTENING (3) ptp.PRE_MASTER (4) ptp.MASTER (5) ptp.PASSIVE (6) ptp.UNCALIBRATED (7) ptp.SLAVE (8) ptp.UNKNOWN (9).
Raises:

slavepreferred property writable 

slavepreferred: str

Access the ptp.slavepreferred attribute.

Description
  • This attribute describes whether you prefer to have the instrument be a subordinate clock or not.
Usage
  • Accessing this property will send the print(ptp.slavepreferred) query.
  • Setting this property to a value will send the ptp.slavepreferred = value command.
TSP Syntax 
- ptp.slavepreferred = value
- print(ptp.slavepreferred)
Raises:

utcoffset property writable 

utcoffset: str

Access the ptp.utcoffset attribute.

Description
  • This attribute describes the offset, in seconds, between UTC and PTP.
Usage
  • Accessing this property will send the print(ptp.utcoffset) query.
  • Setting this property to a value will send the ptp.utcoffset = value command.
TSP Syntax 
- ptp.utcoffset = value
- print(ptp.utcoffset)
Raises:

time 

time() -> str

Run the ptp.time() function.

Description
  • This function is a read-only string that returns the PTP time in seconds and fractional seconds.
TSP Syntax 
- ptp.time()
Returns:
  • str –

    The result of the function call.
Raises:

PtpDs

Bases: BaseTSPCmd

The ptp.ds command tree.

Properties and methods
  • .info: The ptp.ds.info function.

info 

info() -> str

Run the ptp.ds.info function.

Description
  • This function is a read-only string that returns the settings of the different data sets (DS) associated with the IEEE-1588 2008 specification.
TSP Syntax 
- ptp.ds.info
Returns:
  • str –

    The result of the function call.
Raises: