Features.fetch_buzzer_codes

Features.fetch_buzzer_codes(update=False, pickle_it=False, data_dir=None, verbose=False)

Fetch buzzer codes from local backup.

Parameters

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

  • pickle_it (bool) – whether to save the data as a pickle file, defaults to False

  • data_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

Example:

>>> from pyrcs.other_assets import Features

>>> features = Features()

>>> # buz_codes_dat = features.fetch_buzzer_codes(verbose=True, update=True)
>>> buz_codes_dat = features.fetch_buzzer_codes()

>>> type(buz_codes_dat)
dict
>>> list(buz_codes_dat.keys())
['Buzzer codes', 'Last updated date']

>>> print(features.BuzzerKey)
Buzzer codes

>>> buz_codes = buz_codes_dat[features.BuzzerKey]

>>> type(buz_codes)
pandas.core.frame.DataFrame
>>> buz_codes.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