Main Page | Modules | Class Hierarchy | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

otRadiationCount Class Reference
[Radiation Watch Pocket Geiger Type 5., Radiation Watch Pocket Geiger Type 5.]

Radiation Watch Pocket Geiger Type 5 library.

#include <otRadiationCount.h>


Public Member Functions

 otRadiationCount ()
bool init (U8 portCountBit, U8 portNoiseBit, U8 timerId)
bool sample (bool &noise)
U32 integrationTime ()
U32 currentRadiationCount ()
U32 radiationCount ()
F32 cpm ()
F32 uSvh ()
F32 uSvhError ()

Static Public Attributes

static U32 _radiationCount
static U32 _noiseCount

Constructor & Destructor Documentation

otRadiationCount.otRadiationCount (   ) 
 

Create the class

Member Function Documentation

F32 otRadiationCount.cpm (   ) 
 

Return the number of radiation count by minute.

Returns:
Counts Per Minutes

U32 otRadiationCount.currentRadiationCount (   ) 
 

Return the current radiation count, that is the number of Gamma ray since the last call to sample(), which reset the current count to 0.

Returns:
Radiation counts

bool otRadiationCount.init (  U8  portCountBit,
U8  portNoiseBit,
U8  timerId
) 
 

Init the class

Parameters:
portCountBit Bit on PF port used for radiation count
portNoiseBit Bit on PG port used for noise detection
timerId Timer identifier. Timer is used for sampling time.
Returns:
True on success

U32 otRadiationCount.integrationTime (   ) 
 

Integration time of traced radiation count (in milliseconds), grows gradually to HISTORY_LENGTH * HISTORY_UNIT * 1000.

Returns:
Integration time as ms

U32 otRadiationCount.radiationCount (   ) 
 

Return the radiation count, that is the number of Gamma ray occured during the integration time.

Returns:
Radiation counts

bool otRadiationCount.sample (  bool &  noise  ) 
 

Call this procedure in infinite loop.

Parameters:
noise Is set to true if noise is detected.
Returns:
True if new counts is read

F32 otRadiationCount.uSvh (   ) 
 

Return the radiation dose, exprimed in Sievert (uSv/h).

Returns:
Radiation dose.

F32 otRadiationCount.uSvhError (   ) 
 

Return the error of the measurement (uSv/h). The range of precision of the measurement is: [ uSvh-uSvhError, uSvh+uSvhError ].

Returns:
Radiation dose error

Field Documentation

U32 otRadiationCount._noiseCount [static]
 

U32 otRadiationCount._radiationCount [static]
 

The documentation for this class was generated from the following file: footer
otStudio - Library Reference - (C) 2020-23 Officina Turini, All Rights Reserved
Document built with Doxygen 1.4.0