Features.fetch_buzzer_codes

Features.fetch_buzzer_codes(update=False, dump_dir=None, verbose=False)

Fetch data of buzzer codes.

Parameters

  • update (bool) – whether to do an update check (for the package data), defaults to False

  • dump_dir (str or None) – name of a folder where the pickle file is to be saved, defaults to None

  • verbose (bool or int) – whether to print relevant information in console, defaults to False

Returns

data of buzzer codes, and date of when the data was last updated

Return type

dict

Examples:

>>> from pyrcs.other_assets import Features  # from pyrcs import Features

>>> feats = Features()

>>> buz_codes = feats.fetch_buzzer_codes()
>>> type(buz_codes)
dict
>>> list(buz_codes.keys())
['Buzzer codes', 'Last updated date']

>>> feats.KEY_TO_BUZZER
'Buzzer codes'

>>> buz_codes_dat = buz_codes[feats.KEY_TO_BUZZER]
>>> 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