[python source code]

schedule

The schedule 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 
- schedule.alarm[N].enable
- schedule.alarm[N].fractionalseconds
- schedule.alarm[N].period
- schedule.alarm[N].ptpseconds
- schedule.alarm[N].repetition
- schedule.alarm[N].seconds
- schedule.disable()

Schedule

Bases: BaseTSPCmd

The schedule command tree.

Properties and methods
  • .alarm: The schedule.alarm[N] command tree.
  • .disable(): The schedule.disable() function.

alarm property 

alarm: dict[int, ScheduleAlarmItem]

Return the schedule.alarm[N] command tree.

Info
  • N, the alarm number (1 or 2).
Constants
  • .EVENT_ID: This constant describes the trigger event generated by the alarm N.
Sub-properties and sub-methods
  • .enable: The schedule.alarm[N].enable attribute.
  • .fractionalseconds: The schedule.alarm[N].fractionalseconds attribute.
  • .period: The schedule.alarm[N].period attribute.
  • .ptpseconds: The schedule.alarm[N].ptpseconds attribute.
  • .repetition: The schedule.alarm[N].repetition attribute.
  • .seconds: The schedule.alarm[N].seconds attribute.

disable 

disable() -> None

Run the schedule.disable() function.

Description
  • This function disables all alarms.
TSP Syntax 
- schedule.disable()
Raises:

ScheduleAlarmItem

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The schedule.alarm[N] command tree.

Info
  • N, the alarm number (1 or 2).
Constants
  • .EVENT_ID: This constant describes the trigger event generated by the alarm N.
Properties and methods
  • .enable: The schedule.alarm[N].enable attribute.
  • .fractionalseconds: The schedule.alarm[N].fractionalseconds attribute.
  • .period: The schedule.alarm[N].period attribute.
  • .ptpseconds: The schedule.alarm[N].ptpseconds attribute.
  • .repetition: The schedule.alarm[N].repetition attribute.
  • .seconds: The schedule.alarm[N].seconds attribute.

EVENT_ID class-attribute instance-attribute 

EVENT_ID = replace('[N]', f'[{split(']', maxsplit=1)[0]}]')

enable property writable 

enable: str

Access the schedule.alarm[N].enable attribute.

Description
  • This attribute enables or disables an alarm.
Usage
  • Accessing this property will send the print(schedule.alarm[N].enable) query.
  • Setting this property to a value will send the schedule.alarm[N].enable = value command.
TSP Syntax 
- schedule.alarm[N].enable = value
- print(schedule.alarm[N].enable)
Info
  • N, the alarm number (1 or 2).
Raises:

fractionalseconds property writable 

fractionalseconds: str

Access the schedule.alarm[N].fractionalseconds attribute.

Description
  • This attribute describes the fractional seconds portion of the alarm time.
Usage
  • Accessing this property will send the print(schedule.alarm[N].fractionalseconds) query.
  • Setting this property to a value will send the schedule.alarm[N].fractionalseconds = value command.
TSP Syntax 
- schedule.alarm[N].fractionalseconds = value
- print(schedule.alarm[N].fractionalseconds)
Info
  • N, the alarm number (1 or 2).
Raises:

period property writable 

period: str

Access the schedule.alarm[N].period attribute.

Description
  • This attribute describes the time, in seconds, between adjacent firings of the alarm.
Usage
  • Accessing this property will send the print(schedule.alarm[N].period) query.
  • Setting this property to a value will send the schedule.alarm[N].period = value command.
TSP Syntax 
- schedule.alarm[N].period = value
- print(schedule.alarm[N].period)
Info
  • N, the alarm number (1 or 2).
Raises:

ptpseconds property writable 

ptpseconds: str

Access the schedule.alarm[N].ptpseconds attribute.

Description
  • The seconds portion of the alarm time in PTP seconds.
Usage
  • Accessing this property will send the print(schedule.alarm[N].ptpseconds) query.
  • Setting this property to a value will send the schedule.alarm[N].ptpseconds = value command.
TSP Syntax 
- schedule.alarm[N].ptpseconds = value
- print(schedule.alarm[N].ptpseconds)
Info
  • N, the alarm (1 or 2).
  • seconds, the seconds portion of the alarm time in PTP seconds.
Raises:

repetition property writable 

repetition: str

Access the schedule.alarm[N].repetition attribute.

Description
  • This attribute describes the number of times an alarm repeats after the first alarm firing.
Usage
  • Accessing this property will send the print(schedule.alarm[N].repetition) query.
  • Setting this property to a value will send the schedule.alarm[N].repetition = value command.
TSP Syntax 
- schedule.alarm[N].repetition = value
- print(schedule.alarm[N].repetition)
Info
  • N, the alarm 1 or 2.
Raises:

seconds property writable 

seconds: str

Access the schedule.alarm[N].seconds attribute.

Description
  • The seconds portion of the alarm time in UTC seconds.
Usage
  • Accessing this property will send the print(schedule.alarm[N].seconds) query.
  • Setting this property to a value will send the schedule.alarm[N].seconds = value command.
TSP Syntax 
- schedule.alarm[N].seconds = value
- print(schedule.alarm[N].seconds)
Info
  • N, the alarm number (1 or 2).
Raises: