[python source code]

eventlog

The eventlog 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 
- eventlog.all()
- eventlog.clear()
- eventlog.count
- eventlog.enable
- eventlog.next()
- eventlog.overwritemethod

Eventlog

Bases: BaseTSPCmd

The eventlog command tree.

Properties and methods
  • .all(): The eventlog.all() function.
  • .clear(): The eventlog.clear() function.
  • .count: The eventlog.count attribute.
  • .enable: The eventlog.enable attribute.
  • .next(): The eventlog.next() function.
  • .overwritemethod: The eventlog.overwritemethod attribute.

count property 

count: str

Access the eventlog.count attribute.

Description
  • This attribute returns the number of unread events in the event log.
Usage
  • Accessing this property will send the print(eventlog.count) query.
TSP Syntax 
- print(eventlog.count)
Raises:

enable property writable 

enable: str

Access the eventlog.enable attribute.

Description
  • This attribute enables or disables the event log.
Usage
  • Accessing this property will send the print(eventlog.enable) query.
  • Setting this property to a value will send the eventlog.enable = value command.
TSP Syntax 
- eventlog.enable = value
- print(eventlog.enable)
Raises:

overwritemethod property writable 

overwritemethod: str

Access the eventlog.overwritemethod attribute.

Description
  • This attribute controls how the event log processes events if the event log is full.
Usage
  • Accessing this property will send the print(eventlog.overwritemethod) query.
  • Setting this property to a value will send the eventlog.overwritemethod = value command.
TSP Syntax 
- eventlog.overwritemethod = value
- print(eventlog.overwritemethod)
Info

  • method, the set to one of the following values:

    • 0 or eventlog.DISCARD_NEWEST: New entries are not logged
    • 1 or eventlog.DISCARD_OLDEST: Old entries are deleted as new events are logged.
Raises:

all 

all() -> str

Run the eventlog.all() function.

Description
  • This function returns all entries from the event log as a single string and removes them from the event log.
TSP Syntax 
- eventlog.all()
Returns:
  • str –

    The result of the function call.
Raises:

clear 

clear() -> None

Run the eventlog.clear() function.

Description
  • This function clears the event log.
TSP Syntax 
- eventlog.clear()
Raises:

next 

next(event_type: str | None = None) -> str

Run the eventlog.next() function.

Description
  • This function returns the oldest unread event message from the event log.
TSP Syntax 
- eventlog.next()
Parameters:
  • event_type (optional, default: None ) –

    Limits the return to specific event log types; set a cumulative integer value that represents the event log types to.
Returns:
  • str –

    The result of the function call.
Raises: