chipscopy.api.ibert.serial_object_base

class chipscopy.api.ibert.serial_object_base.SerialObjectBase(*, name, type, parent, handle, core_tcf_node, property_for_alias, is_property_endpoint, modifiable_aliases)[source]

Abstract base class for all serial objects

property aliases

Returns:

Return type

Set[str]

children: chipscopy.api.containers.QueryList[child_type]

Direct children of this object

handle: typing_extensions.Final[str]

Object handle from cs_server

name: typing_extensions.Final[str]

Object name

parent: typing_extensions.Final[parent_type]

Parent of this object

property_for_alias: Dict[str, str]

Alias to property name mapping

type: typing_extensions.Final[str]

Object type

See also

chipscopy.api.ibert.serial_object_base.IBERTPropertyCommands.get(self, property_names)

Get the property value cached in cs_server

Parameters

property_names (Union[str, List[str]]) – Property name(s)

Return type

Dict[str, Any]

Returns

Dictionary with property name and value as key, value pairs.

chipscopy.api.ibert.serial_object_base.IBERTPropertyCommands.set(self, **property_dict)

Set new values for properties in cs_server

Parameters

**property_dict – Unpacked dict with key as property and value as new property value

chipscopy.api.ibert.serial_object_base.IBERTPropertyCommands.commit(self, property_names)

Commit the value of properties to HW

Parameters

property_names (Union[str, List[str]]) – Property name(s)

chipscopy.api.ibert.serial_object_base.IBERTPropertyCommands.refresh(self, property_names)

Refresh the value of properties and update it in cs_server

Parameters

property_names (Union[str, List[str]]) – Property name(s)

Return type

Dict[str, Any]

Returns

Dictionary with property name and refreshed value as key, value pairs.

chipscopy.api.ibert.serial_object_base.IBERTPropertyCommands.report(self, property_names=None)

Generate a report providing detailed information about the properties.

Parameters

property_names (Union[str, List[str], None]) – Property name(s)

Return type

Dict[str, Dict[str, Any]]

Returns

Dictionary with property name and information as key, value pairs.

chipscopy.api.ibert.serial_object_base.IBERTWatchlist.add(self, property_names, *, listeners=None)

Add properties to the watchlist

Parameters

  • property_names (Union[str, List[str]]) – Property name(s)

  • listeners (Union[Callable[[ForwardRef], None], List[Callable[[ForwardRef], None]], None]) – Callback to be called when the property update event is received from cs_server

chipscopy.api.ibert.serial_object_base.IBERTWatchlist.remove(self, property_names)

Remove properties from watchlist

Parameters

property_names (Union[str, List[str]]) – Property name(s)