Core

[Arunesh-Gour]

Core API

Core

Core.gettanklist()

• Return tuple of names of tanks currently in system.

Core.getTank(tankname)

• tankname : str - Name of tank, to fetch from system.
• Returns 'FishTank' object.

FishTank

FishTank.read('?')

• Returns tuple of variables read/write-able.

FishTank.read(key)

• key : str - Variable to read from FishTank.
• Returns value stored in variable against supplied key.

FishTank.write(key, value, True)

• key : str - Variable to be over-written.
• value : float - Value to be stored against supplied key. Do not supply 'int'.
• True : bool - Additional value, used by system to differentiate callers. Must be True.

Readable Keys (case-sensitive)

• DO - dissolved oxygen.
• NO2 - nitrite.
• NO3 - nitrate.
• TAN - total ammonia nitrogen.
• temperature - tank temperature.
• pH - pH level.
• waterLevel - percentage of tank filled.
• unionizedNH3 - unionized ammonia in water.

Raises

• TypeError - if value other than 'float' is supplied. Not even 'int' will work.
• ValueError - if value is not in realistic range.

Realistic ranges

• 0.0 <= DO <= 2000.0
• 0.0 <= NO2 <= 2000.0
• 0.0 <= NO3 <= 2000.0
• 0.0 <= TAN <= 2000.0
• -50.0 <= temperature <= 60.0
• 0.0 <= pH<= 14.0
• 0.0 <= waterLevel <= 100.0
• 0.0 <= unionizedNH3 <= 2000.0

Usage

$ denotes spacing (for indentation) as well as command's beginning, in new line.

• $ import Core
• $ DBDIR = '../Applications/DB'
• $ core = Core.Core(DBDIR)
• $ for tank in core.gettanklist():
• $$ tank = core.getTank(tank)
• $$ for key in tank.read('?'):
• $$$ print(key, tank.read(key))
• $$$ tank.write(key, 11.21, True)