[python source code]

eventlog

The eventlog commands module.

These commands are used in the following models: DAQ6510, DMM6500, DMM7510, SMU2450, SMU2460, SMU2461, SMU2470

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

Please report an issue if one is found.

Attributes and Functions 
- eventlog.clear()
- eventlog.getcount()
- eventlog.next()
- eventlog.post()
- eventlog.save()

Eventlog

Bases: BaseTSPCmd

The eventlog command tree.

Constants
  • .SEV_ALL: Returns the total number of unread events in the event log.
  • .SEV_ERROR: Returns the number of error events in the event log.
  • .SEV_INFO: Returns the number of information messages in the event log.
  • .SEV_WARN: Returns the number of warnings in the event log.
Properties and methods
  • .clear(): The eventlog.clear() function.
  • .getcount(): The eventlog.getcount() function.
  • .next(): The eventlog.next() function.
  • .post(): The eventlog.post() function.
  • .save(): The eventlog.save() function.

SEV_ALL class-attribute instance-attribute 

SEV_ALL = 'eventlog.SEV_ALL'

SEV_ERROR class-attribute instance-attribute 

SEV_ERROR = 'eventlog.SEV_ERROR'

SEV_INFO class-attribute instance-attribute 

SEV_INFO = 'eventlog.SEV_INFO'

SEV_WARN class-attribute instance-attribute 

SEV_WARN = 'eventlog.SEV_WARN'

clear 

clear() -> None

Run the eventlog.clear() function.

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

getcount 

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

Run the eventlog.getcount() function.

Description
  • This function returns the number of unread events in the event log.
TSP Syntax 
- eventlog.getcount()
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:

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:

post 

post(message: str, event_type: str | None = None) -> None

Run the eventlog.post() function.

Description
  • This function allows you to post your own text to the event log.
TSP Syntax 
- eventlog.post()
Parameters:
  • message (str) –

    String that contains the message.

  • event_type (optional, default: None ) –

    The type of event; if no event is defined, defaults to eventlog.SEV_INFO.
Raises:

save 

save(filename: str, event_type: str | None = None) -> None

Run the eventlog.save() function.

Description
  • This function saves the event log to a file on a USB flash drive.
TSP Syntax 
- eventlog.save()
Parameters:
  • filename (str) –

    A string that represents the name of the file to be saved.

  • 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.
Raises: