pylab_ml.matrix.base_pickering.Pickering

class Pickering(**kwargs)[source]

Bases: Instrument

Base Class, Interface to the Pickering Matrix Card.

Date:

June 16, 2026

Author:

Semi-ATE <info@Semi-ATE.org>

The Pickering baseclass can connect to Pickering Matrix Card

__init__(**kwargs)[source]

Initialise the Pickering Matrix Card.

Initialization arguments:
addrint

interface PXIslot address

interfacedev_interface.Instrument

pxie

Example: Initialization
>>> instrument = NatInst(addr=3)     # PXIe slot address
>>> instrument.init()                # connect and initialize instrument

Methods

__init__(**kwargs)

Initialise the Pickering Matrix Card.

clear()

Clear error status.

close()

Close connection to Pickering device.

error_list()

List of outstanding errors.

find_names()

find_names() returns list of identifiers strings, lhs of = assignments

findcard()

Find address for Pickering Card.

help()

Print the docstring of the instrument class.

identify([showInstName])

Identify message.

init([identify])

Optional init for interlock startup after identification.

local()

Not possible, always remote control.

message([message])

Device has no display, message display to logger.

mqtt_add(client, instrument[, liste, qos])

Add the instrument to mqtt.

mqtt_disconnect()

Remove the instrument from mqtt.

publish(topic, value)

Publish topic as type='cmd' with payload=value.

publish_get(function_name, value)

Publish function_name as type='get' with paylad=value.

publish_set(function_name, value)

Publish function_name as type='set' with paylad=value.

reset()

Reset.

setup_inst()

Setup the instrument settings.

Attributes

command

id

Get the id from the device.

interchoices

Abstract for static class variable interchoices, to list interfaces statically.

mqtt_enable

mqtt_list

mqtt_status

Getter for the mqtt_status.
clear()[source]

Clear error status.

close()[source]

Close connection to Pickering device.

error_list()[source]

List of outstanding errors.

find_names()

find_names() returns list of identifiers strings, lhs of = assignments

Returns:

obj_names – List of identifier strings

Return type:

list of str

findcard()[source]

Find address for Pickering Card.

Returns:

-1 if no card found
addr if card found
-1 and display addr if more than 1 card found.

Return type:

int

help()

Print the docstring of the instrument class.

property id

Get the id from the device.

identify(showInstName=False)

Identify message.

init(identify=False)

Optional init for interlock startup after identification.

abstract property interchoices

Abstract for static class variable interchoices, to list interfaces statically.

json = <module 'json' from '/home/runner/miniconda3/envs/test/lib/python3.9/json/__init__.py'>
local()[source]

Not possible, always remote control.

message(message=None)[source]

Device has no display, message display to logger.

mqtt_add(client, instrument, liste='#', qos=0)

Add the instrument to mqtt. Calling from base_instrument, after the instrument (device) has been create. Normally you have not to use this function, only base_instrument use it.

Parameters:

  • client (mqtt_init) – The MQTT client instance to which the instrument should be added.

  • instrument (object) – The instrument to be added to the MQTT client.

  • liste (list or str) – A list of attributes for which MQTT messages should be sent. If set to “#”, all attributes will be included (default: “#”).

  • qos (int) – The Quality of Service level for MQTT messages (default: 0).

Return type:

None

mqtt_disconnect()

Remove the instrument from mqtt. Calling from base_instrument, if the instrument are closing. Normally you have not to use this function, only base_instrument use it.

property mqtt_status

Getter for the mqtt_status.

publish(topic, value)

Publish topic as type=’cmd’ with payload=value.

Parameters:

  • topic (str) – The name of the topic to publish.

  • value (any) – The value to be published.

Return type:

None

publish_get(function_name, value)

Publish function_name as type=’get’ with paylad=value.

Parameters:

  • function_name (str) – The name of the function to be published as a ‘get’ command.

  • value (any) – The value to be published as the payload of the ‘get’ command.

Return type:

None

publish_set(function_name, value)

Publish function_name as type=’set’ with paylad=value.

Parameters:

  • function_name (str) – The name of the function to be published as a ‘set’ command.

  • value (any) – The value to be published as the payload of the ‘set’ command.

Return type:

None

reset()[source]

Reset.

setup_inst()

Setup the instrument settings.