Skip to content

Commit

Permalink
All read-only input pointer parameters are marked as 'const'
Browse files Browse the repository at this point in the history
  • Loading branch information
joysfera committed Jul 5, 2013
1 parent 82e938c commit c3e1e8f
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 44 deletions.
42 changes: 21 additions & 21 deletions DallasTemperature.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ uint8_t DallasTemperature::getDeviceCount(void)
}

// returns true if address is valid
bool DallasTemperature::validAddress(uint8_t* deviceAddress)
bool DallasTemperature::validAddress(const uint8_t* deviceAddress)
{
return (_wire->crc8(deviceAddress, 7) == deviceAddress[7]);
}
Expand All @@ -85,22 +85,22 @@ bool DallasTemperature::getAddress(uint8_t* deviceAddress, uint8_t index)
}

// attempt to determine if the device at the given address is connected to the bus
bool DallasTemperature::isConnected(uint8_t* deviceAddress)
bool DallasTemperature::isConnected(const uint8_t* deviceAddress)
{
ScratchPad scratchPad;
return isConnected(deviceAddress, scratchPad);
}

// attempt to determine if the device at the given address is connected to the bus
// also allows for updating the read scratchpad
bool DallasTemperature::isConnected(uint8_t* deviceAddress, uint8_t* scratchPad)
bool DallasTemperature::isConnected(const uint8_t* deviceAddress, uint8_t* scratchPad)
{
readScratchPad(deviceAddress, scratchPad);
return (_wire->crc8(scratchPad, 8) == scratchPad[SCRATCHPAD_CRC]);
}

// read device's scratch pad
void DallasTemperature::readScratchPad(uint8_t* deviceAddress, uint8_t* scratchPad)
void DallasTemperature::readScratchPad(const uint8_t* deviceAddress, uint8_t* scratchPad)
{
// send the command
_wire->reset();
Expand Down Expand Up @@ -168,7 +168,7 @@ void DallasTemperature::readScratchPad(uint8_t* deviceAddress, uint8_t* scratchP
}

// writes device's scratch pad
void DallasTemperature::writeScratchPad(uint8_t* deviceAddress, const uint8_t* scratchPad)
void DallasTemperature::writeScratchPad(const uint8_t* deviceAddress, const uint8_t* scratchPad)
{
_wire->reset();
_wire->select(deviceAddress);
Expand All @@ -185,7 +185,7 @@ void DallasTemperature::writeScratchPad(uint8_t* deviceAddress, const uint8_t* s
}

// reads the device's power requirements
bool DallasTemperature::readPowerSupply(uint8_t* deviceAddress)
bool DallasTemperature::readPowerSupply(const uint8_t* deviceAddress)
{
bool ret = false;
_wire->reset();
Expand All @@ -212,7 +212,7 @@ void DallasTemperature::setResolution(uint8_t newResolution)

// set resolution of a device to 9, 10, 11, or 12 bits
// if new resolution is out of range, 9 bits is used.
bool DallasTemperature::setResolution(uint8_t* deviceAddress, uint8_t newResolution)
bool DallasTemperature::setResolution(const uint8_t* deviceAddress, uint8_t newResolution)
{
ScratchPad scratchPad;
if (isConnected(deviceAddress, scratchPad))
Expand Down Expand Up @@ -251,7 +251,7 @@ uint8_t DallasTemperature::getResolution()

// returns the current resolution of the device, 9-12
// returns 0 if device not found
uint8_t DallasTemperature::getResolution(uint8_t* deviceAddress)
uint8_t DallasTemperature::getResolution(const uint8_t* deviceAddress)
{
// this model has a fixed resolution of 9 bits but getTemp calculates
// a full 12 bits resolution and we need 750ms convert time
Expand Down Expand Up @@ -311,7 +311,7 @@ bool DallasTemperature::getCheckForConversion()
return checkForConversion;
}

bool DallasTemperature::isConversionAvailable(uint8_t* deviceAddress)
bool DallasTemperature::isConversionAvailable(const uint8_t* deviceAddress)
{
// Check if the clock has been raised indicating the conversion is complete
ScratchPad scratchPad;
Expand All @@ -335,7 +335,7 @@ void DallasTemperature::requestTemperatures()
// sends command for one device to perform a temperature by address
// returns FALSE if device is disconnected
// returns TRUE otherwise
bool DallasTemperature::requestTemperaturesByAddress(uint8_t* deviceAddress)
bool DallasTemperature::requestTemperaturesByAddress(const uint8_t* deviceAddress)
{

_wire->reset();
Expand All @@ -355,7 +355,7 @@ bool DallasTemperature::requestTemperaturesByAddress(uint8_t* deviceAddress)
}


void DallasTemperature::blockTillConversionComplete(uint8_t bitResolution, uint8_t* deviceAddress)
void DallasTemperature::blockTillConversionComplete(uint8_t bitResolution, const uint8_t* deviceAddress)
{
if(deviceAddress != 0 && checkForConversion && !parasite)
{
Expand Down Expand Up @@ -411,7 +411,7 @@ float DallasTemperature::getTempFByIndex(uint8_t deviceIndex)
}

// reads scratchpad and returns the raw temperature (12bit)
int16_t DallasTemperature::calculateTemperature(uint8_t* deviceAddress, uint8_t* scratchPad)
int16_t DallasTemperature::calculateTemperature(const uint8_t* deviceAddress, uint8_t* scratchPad)
{
int16_t rawTemperature = (((int16_t)scratchPad[TEMP_MSB]) << 8) | scratchPad[TEMP_LSB];

Expand Down Expand Up @@ -447,7 +447,7 @@ int16_t DallasTemperature::calculateTemperature(uint8_t* deviceAddress, uint8_t*
// the numeric value of DEVICE_DISCONNECTED_RAW is defined in
// DallasTemperature.h. It is a large negative number outside the
// operating range of the device
int16_t DallasTemperature::getTemp(uint8_t* deviceAddress)
int16_t DallasTemperature::getTemp(const uint8_t* deviceAddress)
{
ScratchPad scratchPad;
if (isConnected(deviceAddress, scratchPad)) return calculateTemperature(deviceAddress, scratchPad);
Expand All @@ -459,7 +459,7 @@ int16_t DallasTemperature::getTemp(uint8_t* deviceAddress)
// the numeric value of DEVICE_DISCONNECTED_C is defined in
// DallasTemperature.h. It is a large negative number outside the
// operating range of the device
float DallasTemperature::getTempC(uint8_t* deviceAddress)
float DallasTemperature::getTempC(const uint8_t* deviceAddress)
{
return rawToCelsius(getTemp(deviceAddress));
}
Expand All @@ -469,7 +469,7 @@ float DallasTemperature::getTempC(uint8_t* deviceAddress)
// the numeric value of DEVICE_DISCONNECTED_F is defined in
// DallasTemperature.h. It is a large negative number outside the
// operating range of the device
float DallasTemperature::getTempF(uint8_t* deviceAddress)
float DallasTemperature::getTempF(const uint8_t* deviceAddress)
{
return rawToFahrenheit(getTemp(deviceAddress));
}
Expand Down Expand Up @@ -505,7 +505,7 @@ the next temperature conversion.
// sets the high alarm temperature for a device in degrees Celsius
// accepts a float, but the alarm resolution will ignore anything
// after a decimal point. valid range is -55C - 125C
void DallasTemperature::setHighAlarmTemp(uint8_t* deviceAddress, char celsius)
void DallasTemperature::setHighAlarmTemp(const uint8_t* deviceAddress, char celsius)
{
// make sure the alarm temperature is within the device's range
if (celsius > 125) celsius = 125;
Expand All @@ -522,7 +522,7 @@ void DallasTemperature::setHighAlarmTemp(uint8_t* deviceAddress, char celsius)
// sets the low alarm temperature for a device in degrees Celsius
// accepts a float, but the alarm resolution will ignore anything
// after a decimal point. valid range is -55C - 125C
void DallasTemperature::setLowAlarmTemp(uint8_t* deviceAddress, char celsius)
void DallasTemperature::setLowAlarmTemp(const uint8_t* deviceAddress, char celsius)
{
// make sure the alarm temperature is within the device's range
if (celsius > 125) celsius = 125;
Expand All @@ -538,7 +538,7 @@ void DallasTemperature::setLowAlarmTemp(uint8_t* deviceAddress, char celsius)

// returns a char with the current high alarm temperature or
// DEVICE_DISCONNECTED for an address
char DallasTemperature::getHighAlarmTemp(uint8_t* deviceAddress)
char DallasTemperature::getHighAlarmTemp(const uint8_t* deviceAddress)
{
ScratchPad scratchPad;
if (isConnected(deviceAddress, scratchPad)) return (char)scratchPad[HIGH_ALARM_TEMP];
Expand All @@ -547,7 +547,7 @@ char DallasTemperature::getHighAlarmTemp(uint8_t* deviceAddress)

// returns a char with the current low alarm temperature or
// DEVICE_DISCONNECTED for an address
char DallasTemperature::getLowAlarmTemp(uint8_t* deviceAddress)
char DallasTemperature::getLowAlarmTemp(const uint8_t* deviceAddress)
{
ScratchPad scratchPad;
if (isConnected(deviceAddress, scratchPad)) return (char)scratchPad[LOW_ALARM_TEMP];
Expand Down Expand Up @@ -644,7 +644,7 @@ bool DallasTemperature::alarmSearch(uint8_t* newAddr)
// TODO: can this be done with only TEMP_MSB REGISTER (faster)
// if ((char) scratchPad[TEMP_MSB] <= (char) scratchPad[LOW_ALARM_TEMP]) return true;
// if ((char) scratchPad[TEMP_MSB] >= (char) scratchPad[HIGH_ALARM_TEMP]) return true;
bool DallasTemperature::hasAlarm(uint8_t* deviceAddress)
bool DallasTemperature::hasAlarm(const uint8_t* deviceAddress)
{
ScratchPad scratchPad;
if (isConnected(deviceAddress, scratchPad))
Expand Down Expand Up @@ -690,7 +690,7 @@ void DallasTemperature::setAlarmHandler(AlarmHandler *handler)
}

// The default alarm handler
void DallasTemperature::defaultAlarmHandler(uint8_t* deviceAddress)
void DallasTemperature::defaultAlarmHandler(const uint8_t* deviceAddress)
{
}

Expand Down
46 changes: 23 additions & 23 deletions DallasTemperature.h
Original file line number Diff line number Diff line change
Expand Up @@ -76,26 +76,26 @@ class DallasTemperature
bool isConversionComplete(void);

// returns true if address is valid
bool validAddress(uint8_t*);
bool validAddress(const uint8_t*);

// finds an address at a given index on the bus
bool getAddress(uint8_t*, const uint8_t);

// attempt to determine if the device at the given address is connected to the bus
bool isConnected(uint8_t*);
bool isConnected(const uint8_t*);

// attempt to determine if the device at the given address is connected to the bus
// also allows for updating the read scratchpad
bool isConnected(uint8_t*, uint8_t*);
bool isConnected(const uint8_t*, uint8_t*);

// read device's scratchpad
void readScratchPad(uint8_t*, uint8_t*);
void readScratchPad(const uint8_t*, uint8_t*);

// write device's scratchpad
void writeScratchPad(uint8_t*, const uint8_t*);
void writeScratchPad(const uint8_t*, const uint8_t*);

// read device's power requirements
bool readPowerSupply(uint8_t*);
bool readPowerSupply(const uint8_t*);

// get global resolution
uint8_t getResolution();
Expand All @@ -104,10 +104,10 @@ class DallasTemperature
void setResolution(uint8_t);

// returns the device resolution: 9, 10, 11, or 12 bits
uint8_t getResolution(uint8_t*);
uint8_t getResolution(const uint8_t*);

// set resolution of a device to 9, 10, 11, or 12 bits
bool setResolution(uint8_t*, uint8_t);
bool setResolution(const uint8_t*, uint8_t);

// sets/gets the waitForConversion flag
void setWaitForConversion(bool);
Expand All @@ -121,19 +121,19 @@ class DallasTemperature
void requestTemperatures(void);

// sends command for one device to perform a temperature conversion by address
bool requestTemperaturesByAddress(uint8_t*);
bool requestTemperaturesByAddress(const uint8_t*);

// sends command for one device to perform a temperature conversion by index
bool requestTemperaturesByIndex(uint8_t);

// returns temperature raw value (12 bit integer of 1/16 degrees C)
int16_t getTemp(uint8_t*);
int16_t getTemp(const uint8_t*);

// returns temperature in degrees C
float getTempC(uint8_t*);
float getTempC(const uint8_t*);

// returns temperature in degrees F
float getTempF(uint8_t*);
float getTempF(const uint8_t*);

// Get temperature for device index (slow)
float getTempCByIndex(uint8_t);
Expand All @@ -144,27 +144,27 @@ class DallasTemperature
// returns true if the bus requires parasite power
bool isParasitePowerMode(void);

bool isConversionAvailable(uint8_t*);
bool isConversionAvailable(const uint8_t*);

#if REQUIRESALARMS

typedef void AlarmHandler(uint8_t*);
typedef void AlarmHandler(const uint8_t*);

// sets the high alarm temperature for a device
// accepts a char. valid range is -55C - 125C
void setHighAlarmTemp(uint8_t*, const char);
void setHighAlarmTemp(const uint8_t*, const char);

// sets the low alarm temperature for a device
// accepts a char. valid range is -55C - 125C
void setLowAlarmTemp(uint8_t*, const char);
void setLowAlarmTemp(const uint8_t*, const char);

// returns a signed char with the current high alarm temperature for a device
// in the range -55C - 125C
char getHighAlarmTemp(uint8_t*);
char getHighAlarmTemp(const uint8_t*);

// returns a signed char with the current low alarm temperature for a device
// in the range -55C - 125C
char getLowAlarmTemp(uint8_t*);
char getLowAlarmTemp(const uint8_t*);

// resets internal variables used for the alarm search
void resetAlarmSearch(void);
Expand All @@ -173,7 +173,7 @@ class DallasTemperature
bool alarmSearch(uint8_t*);

// returns true if ia specific device has an alarm
bool hasAlarm(uint8_t*);
bool hasAlarm(const uint8_t*);

// returns true if any device is reporting an alarm on the bus
bool hasAlarm(void);
Expand All @@ -182,10 +182,10 @@ class DallasTemperature
void processAlarms(void);

// sets the alarm handler
void setAlarmHandler(AlarmHandler *);
void setAlarmHandler(const AlarmHandler *);

// The default alarm handler
static void defaultAlarmHandler(uint8_t*);
static void defaultAlarmHandler(const uint8_t*);

#endif

Expand Down Expand Up @@ -234,9 +234,9 @@ class DallasTemperature
OneWire* _wire;

// reads scratchpad and returns the raw temperature
int16_t calculateTemperature(uint8_t*, uint8_t*);
int16_t calculateTemperature(const uint8_t*, uint8_t*);

void blockTillConversionComplete(uint8_t, uint8_t*);
void blockTillConversionComplete(uint8_t, const uint8_t*);

#if REQUIRESALARMS

Expand Down

0 comments on commit c3e1e8f

Please sign in to comment.