Buzzer.fetch_codes

Buzzer.fetch_codes(update=False, dump_dir=None, verbose=False, **kwargs)[source]

Fetch data of buzzer codes.

Parameters:

  • update (bool) – Whether to check for updates to the package data; defaults to False.

  • dump_dir (str | None) – The path to a directory where the data file will be saved; defaults to None.

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

Returns:

A dictionary containing the data of buzzer codes and the date they were last updated

Return type:

dict

Examples:

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

>>> buz = Buzzer()

>>> buz_codes = buz.fetch_codes()

>>> 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.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