Actions
Submodules
mischbares.action.autolab_action module
autolab action
- class mischbares.action.autolab_action.ReturnClass(*, parameters: dict = None, data: dict = None)[source]
Bases:
pydantic.main.BaseModeldefine a return class for returning the result with pydantic.
- data: dict
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'data': FieldInfo(annotation=dict, required=False), 'parameters': FieldInfo(annotation=dict, required=False)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- parameters: dict
- mischbares.action.autolab_action.applied_potential()[source]
get the current applied potential of the cell vs reference electrode.
- Returns
return class with the parameters and the data.
- Return type
retc (ReturnClass)
- mischbares.action.autolab_action.current()[source]
get the current applied potential of the cell vs reference electrode.
- Returns
return class with the parameters and the data.
- Return type
retc (ReturnClass)
- mischbares.action.autolab_action.health_check()[source]
health check to see if the server is up and running :returns: status :rtype: dict
- mischbares.action.autolab_action.measure(procedure: str, plot_type: str, parse_instruction, save_dir: str, setpoints, current_range: str = '1mA', on_off_status: str = 'off', optional_name: Optional[str] = None, measure_at_ocp: bool = False, measurement_id: Optional[int] = None)[source]
measure the requested procedure. :param procedure: procedure to be measured. :type procedure: str :param plot_type: plot type of the procedure. :type plot_type: str :param parse_instruction: parse instruction of the procedure. :type parse_instruction: str :param save_dir: save directory of the procedure. :type save_dir: str :param setpoints: setpoints of the procedure. :type setpoints: str :param current_range: current range of the instrument. :type current_range: str, optional :param on_off_status: on or off status of the cell. :type on_off_status: str, optional :param optional_name: optional name of the procedure. :type optional_name: str, optional :param measure_at_ocp: measure at ocp or not. :type measure_at_ocp: bool, optional
- Returns
return class with the parameters and the data.
- Return type
retc (ReturnClass)
- mischbares.action.autolab_action.measure_status()[source]
check if the instrument is measuring.
- Returns
return class with the parameters and the data.
- Return type
retc (ReturnClass)
- mischbares.action.autolab_action.potential()[source]
get the current potential of the cell.
- Returns
return class with the parameters and the data.
- Return type
retc (ReturnClass)
- mischbares.action.autolab_action.retrieve(save_dir: str, file_name: str)[source]
retrieve the data from the file.
- Parameters
save_dir (str) – directory of the file.
file_name (str) – name of the file.
- Returns
return class with the parameters and the data.
- Return type
retc (ReturnClass)
- mischbares.action.autolab_action.set_cell(onoff: str)[source]
turn the cell on or off.
- Parameters
onoff (str) – “on” or “off” for the cell.
- Returns
return class with the parameters and the data
- Return type
retc (ReturnClass)