eunkyoung kim / LM75B

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of LM75B by Neil Thiessen

LM75B.h@8:2b797c309258, 2013-08-14 (annotated)

Committer:
neilt6
Date:
Wed Aug 14 04:33:25 2013 +0000
Revision:
8:2b797c309258
Parent:
7:bebde8098fca
Child:
9:74b44a27fa40
Modified library so as to be more compliant with C++ conventions

Who changed what in which revision?

UserRevisionLine numberNew contents of line
neilt6 2:9ecc39b2ca70 1 /* LM75B Driver Library
neilt6 4:06676376766a 2 * Copyright (c) 2013 Neil Thiessen
neilt6 0:557a92280097 3 *
neilt6 3:9d68eed28bfb 4 * Licensed under the Apache License, Version 2.0 (the "License");
neilt6 3:9d68eed28bfb 5 * you may not use this file except in compliance with the License.
neilt6 3:9d68eed28bfb 6 * You may obtain a copy of the License at
neilt6 4:06676376766a 7 *
neilt6 4:06676376766a 8 * http://www.apache.org/licenses/LICENSE-2.0
neilt6 0:557a92280097 9 *
neilt6 3:9d68eed28bfb 10 * Unless required by applicable law or agreed to in writing, software
neilt6 3:9d68eed28bfb 11 * distributed under the License is distributed on an "AS IS" BASIS,
neilt6 3:9d68eed28bfb 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
neilt6 3:9d68eed28bfb 13 * See the License for the specific language governing permissions and
neilt6 3:9d68eed28bfb 14 * limitations under the License.
neilt6 0:557a92280097 15 */
neilt6 0:557a92280097 16
neilt6 0:557a92280097 17 #ifndef LM75B_H
neilt6 0:557a92280097 18 #define LM75B_H
neilt6 0:557a92280097 19
neilt6 0:557a92280097 20 #include "mbed.h"
neilt6 0:557a92280097 21
neilt6 0:557a92280097 22 /** LM75B class.
neilt6 0:557a92280097 23 * Used for controlling an LM75B temperature sensor connected via I2C.
neilt6 0:557a92280097 24 *
neilt6 0:557a92280097 25 * Example:
neilt6 0:557a92280097 26 * @code
neilt6 0:557a92280097 27 * #include "mbed.h"
neilt6 0:557a92280097 28 * #include "LM75B.h"
neilt6 0:557a92280097 29 *
neilt6 2:9ecc39b2ca70 30 * LM75B sensor(p28, p27, LM75B::ADDRESS_0);
neilt6 0:557a92280097 31 *
neilt6 0:557a92280097 32 * int main() {
neilt6 0:557a92280097 33 * while (1) {
neilt6 0:557a92280097 34 * //Read the temperature
neilt6 8:2b797c309258 35 * float temp = sensor.temp();
neilt6 0:557a92280097 36 *
neilt6 0:557a92280097 37 * //Print the temperature
neilt6 8:2b797c309258 38 * printf("Temp = %.3f\n", temp);
neilt6 0:557a92280097 39 *
neilt6 0:557a92280097 40 * //Sleep for 0.5 seconds
neilt6 0:557a92280097 41 * wait(0.5);
neilt6 0:557a92280097 42 * }
neilt6 0:557a92280097 43 * }
neilt6 0:557a92280097 44 * @endcode
neilt6 0:557a92280097 45 */
neilt6 0:557a92280097 46 class LM75B
neilt6 0:557a92280097 47 {
neilt6 0:557a92280097 48 public:
neilt6 2:9ecc39b2ca70 49 /** Represents the different I2C address possibilities for the LM75B
neilt6 2:9ecc39b2ca70 50 */
neilt6 2:9ecc39b2ca70 51 enum Address {
neilt6 2:9ecc39b2ca70 52 ADDRESS_0 = (0x48 << 1), /**< A[2:0] pins = 000 */
neilt6 2:9ecc39b2ca70 53 ADDRESS_1 = (0x49 << 1), /**< A[2:0] pins = 001 */
neilt6 2:9ecc39b2ca70 54 ADDRESS_2 = (0x4A << 1), /**< A[2:0] pins = 010 */
neilt6 2:9ecc39b2ca70 55 ADDRESS_3 = (0x4B << 1), /**< A[2:0] pins = 011 */
neilt6 2:9ecc39b2ca70 56 ADDRESS_4 = (0x4C << 1), /**< A[2:0] pins = 100 */
neilt6 2:9ecc39b2ca70 57 ADDRESS_5 = (0x4D << 1), /**< A[2:0] pins = 101 */
neilt6 2:9ecc39b2ca70 58 ADDRESS_6 = (0x4E << 1), /**< A[2:0] pins = 110 */
neilt6 2:9ecc39b2ca70 59 ADDRESS_7 = (0x4F << 1) /**< A[2:0] pins = 111 */
neilt6 2:9ecc39b2ca70 60 };
neilt6 2:9ecc39b2ca70 61
neilt6 2:9ecc39b2ca70 62 /** Represents the power mode of the LM75B
neilt6 2:9ecc39b2ca70 63 */
neilt6 2:9ecc39b2ca70 64 enum PowerMode {
neilt6 2:9ecc39b2ca70 65 POWER_NORMAL, /**< Chip is enabled and samples every 100ms */
neilt6 2:9ecc39b2ca70 66 POWER_SHUTDOWN /**< Chip is in low-power shutdown mode */
neilt6 2:9ecc39b2ca70 67 };
neilt6 2:9ecc39b2ca70 68
neilt6 2:9ecc39b2ca70 69 /** Represents OS pin mode of the LM75B
neilt6 2:9ecc39b2ca70 70 */
neilt6 2:9ecc39b2ca70 71 enum OSMode {
neilt6 2:9ecc39b2ca70 72 OS_COMPARATOR, /**< OS is asserted when the temperature reaches the alert threshold, and de-asserted when the temperature drops below the alert hysteresis threshold */
neilt6 2:9ecc39b2ca70 73 OS_INTERRUPT /**< OS is asserted when the temperature reaches the alert threshold, or drops below the alert hysteresis threshold, and only de-asserted when a register has been read */
neilt6 2:9ecc39b2ca70 74 };
neilt6 2:9ecc39b2ca70 75
neilt6 2:9ecc39b2ca70 76 /** Represents OS pin polarity of the LM75B
neilt6 2:9ecc39b2ca70 77 */
neilt6 2:9ecc39b2ca70 78 enum OSPolarity {
neilt6 2:9ecc39b2ca70 79 OS_ACTIVE_LOW, /**< OS is a logic low when asserted, and a logic high when de-asserted */
neilt6 2:9ecc39b2ca70 80 OS_ACTIVE_HIGH /**< OS is a logic high when asserted, and a logic low when de-asserted */
neilt6 2:9ecc39b2ca70 81 };
neilt6 2:9ecc39b2ca70 82
neilt6 2:9ecc39b2ca70 83 /** Represents OS pin fault queue length of the LM75B
neilt6 2:9ecc39b2ca70 84 */
neilt6 2:9ecc39b2ca70 85 enum OSFaultQueue {
neilt6 2:9ecc39b2ca70 86 OS_FAULT_QUEUE_1, /**< OS is asserted after 1 fault */
neilt6 2:9ecc39b2ca70 87 OS_FAULT_QUEUE_2, /**< OS is asserted after 2 consecutive faults */
neilt6 2:9ecc39b2ca70 88 OS_FAULT_QUEUE_4, /**< OS is asserted after 4 consecutive faults */
neilt6 2:9ecc39b2ca70 89 OS_FAULT_QUEUE_6 /**< OS is asserted after 6 consecutive faults */
neilt6 2:9ecc39b2ca70 90 };
neilt6 2:9ecc39b2ca70 91
neilt6 0:557a92280097 92 /** Create an LM75B object connected to the specified I2C pins with the specified I2C slave address
neilt6 0:557a92280097 93 *
neilt6 7:bebde8098fca 94 * @param sda The I2C data pin.
neilt6 7:bebde8098fca 95 * @param scl The I2C clock pin.
neilt6 7:bebde8098fca 96 * @param addr The I2C slave address.
neilt6 0:557a92280097 97 */
neilt6 2:9ecc39b2ca70 98 LM75B(PinName sda, PinName scl, Address addr);
neilt6 2:9ecc39b2ca70 99
neilt6 0:557a92280097 100 /** Get the current power mode of the LM75B
neilt6 0:557a92280097 101 *
neilt6 6:6b8a9d1ad49a 102 * @returns The current power mode as a PowerMode enum.
neilt6 0:557a92280097 103 */
neilt6 8:2b797c309258 104 LM75B::PowerMode powerMode(void);
neilt6 2:9ecc39b2ca70 105
neilt6 0:557a92280097 106 /** Set the power mode of the LM75B
neilt6 0:557a92280097 107 *
neilt6 6:6b8a9d1ad49a 108 * @param mode The new power mode as a PowerMode enum.
neilt6 0:557a92280097 109 */
neilt6 8:2b797c309258 110 void powerMode(PowerMode mode);
neilt6 2:9ecc39b2ca70 111
neilt6 0:557a92280097 112 /** Get the current OS pin mode of the LM75B
neilt6 0:557a92280097 113 *
neilt6 6:6b8a9d1ad49a 114 * @returns The current OS pin mode as an OSMode enum.
neilt6 0:557a92280097 115 */
neilt6 8:2b797c309258 116 LM75B::OSMode osMode(void);
neilt6 2:9ecc39b2ca70 117
neilt6 0:557a92280097 118 /** Set the OS pin mode of the LM75B
neilt6 0:557a92280097 119 *
neilt6 6:6b8a9d1ad49a 120 * @param mode The new OS pin mode as an OSMode enum.
neilt6 0:557a92280097 121 */
neilt6 8:2b797c309258 122 void osMode(OSMode mode);
neilt6 2:9ecc39b2ca70 123
neilt6 0:557a92280097 124 /** Get the current OS pin polarity of the LM75B
neilt6 0:557a92280097 125 *
neilt6 6:6b8a9d1ad49a 126 * @returns The current OS pin polarity as an OSPolarity enum.
neilt6 0:557a92280097 127 */
neilt6 8:2b797c309258 128 LM75B::OSPolarity osPolarity(void);
neilt6 2:9ecc39b2ca70 129
neilt6 0:557a92280097 130 /** Set the OS pin polarity of the LM75B
neilt6 0:557a92280097 131 *
neilt6 6:6b8a9d1ad49a 132 * @param polarity The new OS pin polarity as an OSPolarity enum.
neilt6 0:557a92280097 133 */
neilt6 8:2b797c309258 134 void osPolarity(OSPolarity polarity);
neilt6 2:9ecc39b2ca70 135
neilt6 0:557a92280097 136 /** Get the current OS pin fault queue length of the LM75B
neilt6 0:557a92280097 137 *
neilt6 6:6b8a9d1ad49a 138 * @returns The current OS pin fault queue length as an OSFaultQueue enum.
neilt6 0:557a92280097 139 */
neilt6 8:2b797c309258 140 LM75B::OSFaultQueue osFaultQueue(void);
neilt6 2:9ecc39b2ca70 141
neilt6 0:557a92280097 142 /** Set the OS pin fault queue length of the LM75B
neilt6 0:557a92280097 143 *
neilt6 6:6b8a9d1ad49a 144 * @param queue The new OS pin fault queue length as an OSFaultQueue enum.
neilt6 0:557a92280097 145 */
neilt6 8:2b797c309258 146 void osFaultQueue(OSFaultQueue queue);
neilt6 2:9ecc39b2ca70 147
neilt6 0:557a92280097 148 /** Get the current alert temperature threshold of the LM75B
neilt6 0:557a92280097 149 *
neilt6 6:6b8a9d1ad49a 150 * @returns The current alert temperature threshold in °C.
neilt6 0:557a92280097 151 */
neilt6 8:2b797c309258 152 float alertTemp(void);
neilt6 2:9ecc39b2ca70 153
neilt6 0:557a92280097 154 /** Set the alert temperature threshold of the LM75B
neilt6 0:557a92280097 155 *
neilt6 6:6b8a9d1ad49a 156 * @param temp The new alert temperature threshold in °C.
neilt6 0:557a92280097 157 */
neilt6 8:2b797c309258 158 void alertTemp(float temp);
neilt6 2:9ecc39b2ca70 159
neilt6 0:557a92280097 160 /** Get the current alert temperature hysteresis threshold of the LM75B
neilt6 0:557a92280097 161 *
neilt6 6:6b8a9d1ad49a 162 * @returns The current alert temperature hysteresis threshold in °C.
neilt6 0:557a92280097 163 */
neilt6 8:2b797c309258 164 float alertHyst(void);
neilt6 2:9ecc39b2ca70 165
neilt6 0:557a92280097 166 /** Set the alert temperature hysteresis threshold of the LM75B
neilt6 0:557a92280097 167 *
neilt6 6:6b8a9d1ad49a 168 * @param temp The new alert temperature hysteresis threshold in °C.
neilt6 0:557a92280097 169 */
neilt6 8:2b797c309258 170 void alertHyst(float temp);
neilt6 2:9ecc39b2ca70 171
neilt6 0:557a92280097 172 /** Get the current temperature measurement of the LM75B
neilt6 0:557a92280097 173 *
neilt6 6:6b8a9d1ad49a 174 * @returns The current temperature measurement in °C.
neilt6 0:557a92280097 175 */
neilt6 8:2b797c309258 176 float temp(void);
neilt6 0:557a92280097 177
neilt6 0:557a92280097 178 private:
neilt6 8:2b797c309258 179 //I2C register addresses
neilt6 8:2b797c309258 180 enum Register {
neilt6 8:2b797c309258 181 REG_TEMP = 0x00,
neilt6 8:2b797c309258 182 REG_CONF = 0x01,
neilt6 8:2b797c309258 183 REG_THYST = 0x02,
neilt6 8:2b797c309258 184 REG_TOS = 0x03
neilt6 8:2b797c309258 185 };
neilt6 8:2b797c309258 186
neilt6 8:2b797c309258 187 //Member variables
neilt6 8:2b797c309258 188 I2C m_I2C;
neilt6 8:2b797c309258 189 int m_Addr;
neilt6 8:2b797c309258 190
neilt6 8:2b797c309258 191 //Internal functions
neilt6 8:2b797c309258 192 char read8(char reg);
neilt6 8:2b797c309258 193 void write8(char reg, char data);
neilt6 8:2b797c309258 194 unsigned short read16(char reg);
neilt6 8:2b797c309258 195 void write16(char reg, unsigned short data);
neilt6 8:2b797c309258 196 float readAlertTempHelper(char reg);
neilt6 8:2b797c309258 197 void writeAlertTempHelper(char reg, float temp);
neilt6 0:557a92280097 198 };
neilt6 0:557a92280097 199
neilt6 5:f8b36d66b768 200 #endif