Buzzer.collect_codes

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

Collects 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()
To collect data of Buzzer codes
? [No]|Yes: yes
>>> type(buz_codes)
dict
>>> list(buz_codes.keys())
['Buzzer codes', 'Last updated date']
>>> buz.KEY
'Buzzer codes'
>>> buz_codes_dat = buz_codes[buz.KEY]
>>> type(buz_codes_dat)
pandas.core.frame.DataFrame
>>> buz_codes_dat.head()
  Code [number of buzzes or groups separated by pauses]            Meaning
0                                                  1                  Stop
1                                                1-2           Close doors
2                                                  2        Ready to start
3                                                2-2     Do not open doors
4                                                  3              Set back