Buzzer.collect_codes

Buzzer.collect_codes(confirmation_required=True, verbose=False, raise_error=False)[source]

Collect data of buzzer codes from the source web page.

Parameters:

  • confirmation_required (bool) – Whether user confirmation is required; if confirmation_required=True (default), prompts the user for confirmation before proceeding with data collection.

  • verbose (bool | int) – Whether to print relevant information to the console; defaults to False.

  • raise_error (bool) – Whether to raise the provided exception; if raise_error=False (default), the error will be suppressed.

Returns:

A dictionary containing the data of buzzer codes and the date they were last updated, or None if no data is collected.

Return type:

dict | None

Examples:

>>> from pyrcs.other_assets import Buzzer  # from pyrcs import Buzzer

>>> buz = Buzzer()

>>> buz_codes = buz.collect_codes(verbose=True)
To collect data of buzzer codes?
 [No]|Yes: yes
Collecting the data ... Done.

>>> type(buz_codes)
dict
>>> list(buz_codes)
['Buzzer codes', 'Last updated date']

>>> buz_codes_dat = buz_codes['Buzzer codes']
>>> type(buz_codes_dat)
pandas.DataFrame
>>> buz_codes_dat.head()
  Code (number of buzzes or groups separate...                                 Meaning
0                                            1                                    Stop
1                                          1-2                             Close doors
2                                            2                          Ready to start
3                                          2-2     Create vacuum [used in early 1960s]
4                                          2-2                       Do not open doors