Mike Fruge / OneWire

Implementation of 1-Wire with added Alarm Search Functionality

Dependents:   Max32630_One_Wire_Interface

OneWire_Bridge/DS28E17/ds28e17.h@4:ca27db159b10, 2016-02-02 (annotated)

Committer:
j3
Date:
Tue Feb 02 21:34:27 2016 +0000
Revision:
4:ca27db159b10
Child:
7:78a8857b3810
publishing privately for collaboration with other team members

Who changed what in which revision?

UserRevisionLine numberNew contents of line
j3 4:ca27db159b10 1 /******************************************************************//**
j3 4:ca27db159b10 2 * @file ds28e17.h
j3 4:ca27db159b10 3 *
j3 4:ca27db159b10 4 * @author Justin Jordan
j3 4:ca27db159b10 5 *
j3 4:ca27db159b10 6 * @version 0.0.0
j3 4:ca27db159b10 7 *
j3 4:ca27db159b10 8 * Started: 31JAN16
j3 4:ca27db159b10 9 *
j3 4:ca27db159b10 10 * Updated:
j3 4:ca27db159b10 11 *
j3 4:ca27db159b10 12 * @brief Header file for DS28E17 1-wire to I2C bridge
j3 4:ca27db159b10 13 ***********************************************************************
j3 4:ca27db159b10 14 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
j3 4:ca27db159b10 15 *
j3 4:ca27db159b10 16 * Permission is hereby granted, free of charge, to any person obtaining a
j3 4:ca27db159b10 17 * copy of this software and associated documentation files (the "Software"),
j3 4:ca27db159b10 18 * to deal in the Software without restriction, including without limitation
j3 4:ca27db159b10 19 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
j3 4:ca27db159b10 20 * and/or sell copies of the Software, and to permit persons to whom the
j3 4:ca27db159b10 21 * Software is furnished to do so, subject to the following conditions:
j3 4:ca27db159b10 22 *
j3 4:ca27db159b10 23 * The above copyright notice and this permission notice shall be included
j3 4:ca27db159b10 24 * in all copies or substantial portions of the Software.
j3 4:ca27db159b10 25 *
j3 4:ca27db159b10 26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
j3 4:ca27db159b10 27 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
j3 4:ca27db159b10 28 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
j3 4:ca27db159b10 29 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
j3 4:ca27db159b10 30 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
j3 4:ca27db159b10 31 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
j3 4:ca27db159b10 32 * OTHER DEALINGS IN THE SOFTWARE.
j3 4:ca27db159b10 33 *
j3 4:ca27db159b10 34 * Except as contained in this notice, the name of Maxim Integrated
j3 4:ca27db159b10 35 * Products, Inc. shall not be used except as stated in the Maxim Integrated
j3 4:ca27db159b10 36 * Products, Inc. Branding Policy.
j3 4:ca27db159b10 37 *
j3 4:ca27db159b10 38 * The mere transfer of this software does not imply any licenses
j3 4:ca27db159b10 39 * of trade secrets, proprietary technology, copyrights, patents,
j3 4:ca27db159b10 40 * trademarks, maskwork rights, or any other form of intellectual
j3 4:ca27db159b10 41 * property whatsoever. Maxim Integrated Products, Inc. retains all
j3 4:ca27db159b10 42 * ownership rights.
j3 4:ca27db159b10 43 **********************************************************************/
j3 4:ca27db159b10 44
j3 4:ca27db159b10 45
j3 4:ca27db159b10 46 #ifndef DS28E17_H
j3 4:ca27db159b10 47 #define DS28E17_H
j3 4:ca27db159b10 48
j3 4:ca27db159b10 49
j3 4:ca27db159b10 50 #include "mbed.h"
j3 4:ca27db159b10 51 #include "OneWireMasters.h"
j3 4:ca27db159b10 52
j3 4:ca27db159b10 53
j3 4:ca27db159b10 54 class Ds28e17
j3 4:ca27db159b10 55 {
j3 4:ca27db159b10 56 public:
j3 4:ca27db159b10 57
j3 4:ca27db159b10 58 /**********************************************************//**
j3 4:ca27db159b10 59 * @brief Ds28e17 constructor
j3 4:ca27db159b10 60 *
j3 4:ca27db159b10 61 * @details
j3 4:ca27db159b10 62 *
j3 4:ca27db159b10 63 * On Entry:
j3 4:ca27db159b10 64 * @param[in] p_owm - pointer to a 1-wire master of the following
j3 4:ca27db159b10 65 * types; Ds248x, Ds2480b, OwGpio which
j3 4:ca27db159b10 66 * inherit the base class 'OneWireInterface'
j3 4:ca27db159b10 67 *
j3 4:ca27db159b10 68 * On Exit:
j3 4:ca27db159b10 69 * @return
j3 4:ca27db159b10 70 **************************************************************/
j3 4:ca27db159b10 71 Ds28e17(OneWireInterface *p_owm);
j3 4:ca27db159b10 72
j3 4:ca27db159b10 73
j3 4:ca27db159b10 74 /**********************************************************//**
j3 4:ca27db159b10 75 * @brief Ds28e17 destructor
j3 4:ca27db159b10 76 *
j3 4:ca27db159b10 77 * @details releases resources used by object
j3 4:ca27db159b10 78 *
j3 4:ca27db159b10 79 * On Entry:
j3 4:ca27db159b10 80 *
j3 4:ca27db159b10 81 * On Exit:
j3 4:ca27db159b10 82 * @return
j3 4:ca27db159b10 83 **************************************************************/
j3 4:ca27db159b10 84 ~Ds28e17();
j3 4:ca27db159b10 85
j3 4:ca27db159b10 86
j3 4:ca27db159b10 87 /**********************************************************//**
j3 4:ca27db159b10 88 * @brief Write to selected DS28E17's I2C with Stop.
j3 4:ca27db159b10 89 * Poll until I2C write complete and receive status info.
j3 4:ca27db159b10 90 *
j3 4:ca27db159b10 91 * @details Output on I2C: S, Address + Write, Write Data [1-255], P
j3 4:ca27db159b10 92 *
j3 4:ca27db159b10 93 * On Entry:
j3 4:ca27db159b10 94 * @param[in] I2C_addr -
j3 4:ca27db159b10 95 * Writes I2C address. The least significant bit of the I2C
j3 4:ca27db159b10 96 * address is automatically cleared by the command.
j3 4:ca27db159b10 97 *
j3 4:ca27db159b10 98 * @param[in] length
j3 4:ca27db159b10 99 * The number of data bytes to be written ranging from 01h to FFh.
j3 4:ca27db159b10 100 * A value of zero will assert the Error Detected pin (ED).
j3 4:ca27db159b10 101 *
j3 4:ca27db159b10 102 * @param[in] *data
j3 4:ca27db159b10 103 * User defines write data ranging from 1-255 bytes.
j3 4:ca27db159b10 104 *
j3 4:ca27db159b10 105 * On Exit:
j3 4:ca27db159b10 106 * @param[out] status
j3 4:ca27db159b10 107 * Detects the condition of the Start (bit3), N/A (bit2),
j3 4:ca27db159b10 108 * Address(bit1) and CRC16(bit0) bits.
j3 4:ca27db159b10 109 * b3;0=No Err|1=I2CStart prev-not issued,
j3 4:ca27db159b10 110 * b2;0=No Err|1=I2C N/A Err,
j3 4:ca27db159b10 111 * b1;0=No Err|1=Addr Err,
j3 4:ca27db159b10 112 * b0;0=Valid CRC16|1=Invalid CRC16
j3 4:ca27db159b10 113 *
j3 4:ca27db159b10 114 * @param[out] wr_status
j3 4:ca27db159b10 115 * Indicates which write byte NACK’d. A value of 00h indicates
j3 4:ca27db159b10 116 * all bytes were acknowledged by the slave.
j3 4:ca27db159b10 117 * A non-zero value indicates the byte number that NACK’d.
j3 4:ca27db159b10 118 *
j3 4:ca27db159b10 119 * @return
j3 4:ca27db159b10 120 * true if device selected and written @n
j3 4:ca27db159b10 121 * false if failed device select
j3 4:ca27db159b10 122 **************************************************************/
j3 4:ca27db159b10 123 bool I2C_WriteDataWithStop(uint8_t I2C_addr, uint8_t length,
j3 4:ca27db159b10 124 uint8_t *data, uint8_t status,
j3 4:ca27db159b10 125 uint8_t wr_status);
j3 4:ca27db159b10 126
j3 4:ca27db159b10 127 /**********************************************************//**
j3 4:ca27db159b10 128 * @brief Write to selected DS28E17's I2C No Stop.
j3 4:ca27db159b10 129 * Poll until I2C write complete and receive status info.
j3 4:ca27db159b10 130 *
j3 4:ca27db159b10 131 * @details Output on I2C: S, Address + Write, Write Data [1-255]
j3 4:ca27db159b10 132 *
j3 4:ca27db159b10 133 * On Entry:
j3 4:ca27db159b10 134 * @param[in] I2C_addr
j3 4:ca27db159b10 135 * Writes I2C address. The least significant bit of the I2C address
j3 4:ca27db159b10 136 * is automatically cleared by the command.
j3 4:ca27db159b10 137 *
j3 4:ca27db159b10 138 * @param[in] length
j3 4:ca27db159b10 139 * The number of data bytes to be written ranging from 01h to FFh.
j3 4:ca27db159b10 140 * A value of zero will assert the Error Detected pin (ED).
j3 4:ca27db159b10 141 *
j3 4:ca27db159b10 142 * @param[in] *data
j3 4:ca27db159b10 143 * User defines write data ranging from 1-255 bytes.
j3 4:ca27db159b10 144 *
j3 4:ca27db159b10 145 * On Exit:
j3 4:ca27db159b10 146 * @param[out] status
j3 4:ca27db159b10 147 * Detects the condition of the Start (bit3), N/A (bit2),
j3 4:ca27db159b10 148 * Address(bit1) and CRC16(bit0) bits.
j3 4:ca27db159b10 149 * b3;0=No Err|1=I2CStart prev-not issued,
j3 4:ca27db159b10 150 * b2;0=No Err|1=I2C N/A Err,
j3 4:ca27db159b10 151 * b1;0=No Err|1=Addr Err,
j3 4:ca27db159b10 152 * b0;0=Valid CRC16|1=Invalid CRC16
j3 4:ca27db159b10 153 *
j3 4:ca27db159b10 154 * @param[out] wr_status
j3 4:ca27db159b10 155 * Indicates which write byte NACK’d. A value of 00h indicates
j3 4:ca27db159b10 156 * all bytes were acknowledged by the slave.
j3 4:ca27db159b10 157 * A non-zero value indicates the byte number that NACK’d.
j3 4:ca27db159b10 158 *
j3 4:ca27db159b10 159 * @return
j3 4:ca27db159b10 160 * true if device selected and written @n
j3 4:ca27db159b10 161 * false if failed device select
j3 4:ca27db159b10 162 **************************************************************/
j3 4:ca27db159b10 163 bool I2C_WriteDataNoStop(uint8_t I2C_addr, uint8_t length,
j3 4:ca27db159b10 164 uint8_t *data, uint8_t status,
j3 4:ca27db159b10 165 uint8_t wr_status);
j3 4:ca27db159b10 166
j3 4:ca27db159b10 167
j3 4:ca27db159b10 168 /**********************************************************//**
j3 4:ca27db159b10 169 * @brief Write to selected DS28E17's I2C with Data only.
j3 4:ca27db159b10 170 * Poll until I2C write complete and receive status info.
j3 4:ca27db159b10 171 *
j3 4:ca27db159b10 172 * @details Output on I2C: Write Data [1-255]
j3 4:ca27db159b10 173 *
j3 4:ca27db159b10 174 * On Entry:
j3 4:ca27db159b10 175 * @param[in] length
j3 4:ca27db159b10 176 * The number of data bytes to be written ranging from 01h to FFh.
j3 4:ca27db159b10 177 * A value of zero will assert the Error Detected pin (ED).
j3 4:ca27db159b10 178 *
j3 4:ca27db159b10 179 * @param[in] *data
j3 4:ca27db159b10 180 * User defines write data ranging from 1-255 bytes.
j3 4:ca27db159b10 181 *
j3 4:ca27db159b10 182 * On Exit:
j3 4:ca27db159b10 183 * @param[out] status
j3 4:ca27db159b10 184 * Detects the condition of the Start (bit3), N/A (bit2),
j3 4:ca27db159b10 185 * Address(bit1) and CRC16(bit0) bits.
j3 4:ca27db159b10 186 * b3;0=No Err|1=I2CStart prev-not issued,
j3 4:ca27db159b10 187 * b2;0=No Err|1=I2C N/A Err,
j3 4:ca27db159b10 188 * b1;0=No Err|1=Addr Err,
j3 4:ca27db159b10 189 * b0;0=Valid CRC16|1=Invalid CRC16
j3 4:ca27db159b10 190 *
j3 4:ca27db159b10 191 * @param[out] wr_status
j3 4:ca27db159b10 192 * Indicates which write byte NACK’d. A value of 00h indicates all bytes were acknowledged by the slave.
j3 4:ca27db159b10 193 * A non-zero value indicates the byte number that NACK’d.
j3 4:ca27db159b10 194 *
j3 4:ca27db159b10 195 * @return
j3 4:ca27db159b10 196 * true if device selected and written @n
j3 4:ca27db159b10 197 * false if failed device select
j3 4:ca27db159b10 198 **************************************************************/
j3 4:ca27db159b10 199 bool I2C_WriteDataOnly(uint8_t length, uint8_t *data,
j3 4:ca27db159b10 200 uint8_t status, uint8_t wr_status);
j3 4:ca27db159b10 201
j3 4:ca27db159b10 202
j3 4:ca27db159b10 203 /**********************************************************//**
j3 4:ca27db159b10 204 * @brief Write to selected DS28E17's I2C with Stop.
j3 4:ca27db159b10 205 * Poll until I2C write complete and receive status info.
j3 4:ca27db159b10 206 *
j3 4:ca27db159b10 207 * @details Output on I2C: Write Data [1-255], P
j3 4:ca27db159b10 208 *
j3 4:ca27db159b10 209 * On Entry:
j3 4:ca27db159b10 210 * @param[in] length
j3 4:ca27db159b10 211 * The number of data bytes to be written ranging from 01h to FFh.
j3 4:ca27db159b10 212 * A value of zero will assert the Error Detected pin (ED).
j3 4:ca27db159b10 213 *
j3 4:ca27db159b10 214 * @param[in] *data
j3 4:ca27db159b10 215 * User defines write data ranging from 1-255 bytes.
j3 4:ca27db159b10 216 *
j3 4:ca27db159b10 217 * On Exit:
j3 4:ca27db159b10 218 * @param[out] status
j3 4:ca27db159b10 219 * Detects the condition of the Start (bit3), N/A (bit2),
j3 4:ca27db159b10 220 * Address(bit1) and CRC16(bit0) bits.
j3 4:ca27db159b10 221 * b3;0=No Err|1=I2CStart prev-not issued,
j3 4:ca27db159b10 222 * b2;0=No Err|1=I2C N/A Err,
j3 4:ca27db159b10 223 * b1;0=No Err|1=Addr Err,
j3 4:ca27db159b10 224 * b0;0=Valid CRC16|1=Invalid CRC16
j3 4:ca27db159b10 225 *
j3 4:ca27db159b10 226 * @param[out] wr_status
j3 4:ca27db159b10 227 * Indicates which write byte NACK’d. A value of 00h indicates all bytes were acknowledged by the slave.
j3 4:ca27db159b10 228 * A non-zero value indicates the byte number that NACK’d.
j3 4:ca27db159b10 229 *
j3 4:ca27db159b10 230 * @return
j3 4:ca27db159b10 231 * true if device selected and written @n
j3 4:ca27db159b10 232 * false if failed device select
j3 4:ca27db159b10 233 **************************************************************/
j3 4:ca27db159b10 234 bool I2C_WriteDataOnlyWithStop(uint8_t length, uint8_t *data,
j3 4:ca27db159b10 235 uint8_t status, uint8_t wr_status);
j3 4:ca27db159b10 236
j3 4:ca27db159b10 237
j3 4:ca27db159b10 238 /**********************************************************//**
j3 4:ca27db159b10 239 * @brief Write to selected DS28E17's I2C with Stop and poll until I2C write complete
j3 4:ca27db159b10 240 * receive status info, and read data with a stop at the end.
j3 4:ca27db159b10 241 *
j3 4:ca27db159b10 242 * @details Output on I2C:
j3 4:ca27db159b10 243 * S, Slave Address + Write, Write Data [1-255],
j3 4:ca27db159b10 244 * Sr, Address + Read, Read Data [1-255], P (NACK last read byte)
j3 4:ca27db159b10 245 *
j3 4:ca27db159b10 246 * On Entry:
j3 4:ca27db159b10 247 * @param[in] I2C_addr
j3 4:ca27db159b10 248 * Writes I2C address. The least significant bit of the I2C address
j3 4:ca27db159b10 249 * is automatically cleared by the command.
j3 4:ca27db159b10 250 *
j3 4:ca27db159b10 251 * @param[in] length
j3 4:ca27db159b10 252 * The number of data bytes to be written ranging from 01h to FFh.
j3 4:ca27db159b10 253 * A value of zero will assert the Error Detected pin (ED).
j3 4:ca27db159b10 254 *
j3 4:ca27db159b10 255 * @param[in] *data
j3 4:ca27db159b10 256 * User defines write data ranging from 1-255 bytes.
j3 4:ca27db159b10 257 *
j3 4:ca27db159b10 258 * On Exit:
j3 4:ca27db159b10 259 * @param[out] nu_bytes_read
j3 4:ca27db159b10 260 * Number of I2C bytes to read. A value of zero will assert the Error Detected pin (ED).
j3 4:ca27db159b10 261 *
j3 4:ca27db159b10 262 * @param[out] status
j3 4:ca27db159b10 263 * Detects the condition of the Start (bit3), N/A (bit2),
j3 4:ca27db159b10 264 * Address(bit1) and CRC16(bit0) bits.
j3 4:ca27db159b10 265 * b3;0=No Err|1=I2CStart prev-not issued,
j3 4:ca27db159b10 266 * b2;0=No Err|1=I2C N/A Err,
j3 4:ca27db159b10 267 * b1;0=No Err|1=Addr Err,
j3 4:ca27db159b10 268 * b0;0=Valid CRC16|1=Invalid CRC16
j3 4:ca27db159b10 269 *
j3 4:ca27db159b10 270 * @param[out] wr_status
j3 4:ca27db159b10 271 * Indicates which write byte NACK’d. A value of 00h indicates all bytes were acknowledged by the slave.
j3 4:ca27db159b10 272 * A non-zero value indicates the byte number that NACK’d.
j3 4:ca27db159b10 273 *
j3 4:ca27db159b10 274 * @param[out] *read_data
j3 4:ca27db159b10 275 * Array of read data received from I2C.
j3 4:ca27db159b10 276 *
j3 4:ca27db159b10 277 * @return
j3 4:ca27db159b10 278 * true if device selected, written and read @n
j3 4:ca27db159b10 279 * false if failed device select or timeout occurred or CRC16 error
j3 4:ca27db159b10 280 **************************************************************/
j3 4:ca27db159b10 281 bool I2C_WriteReadDataWithStop(uint8_t I2C_addr, uint8_t length,
j3 4:ca27db159b10 282 uint8_t *data, uint8_t nu_bytes_read,
j3 4:ca27db159b10 283 uint8_t status, uint8_t wr_status,
j3 4:ca27db159b10 284 uint8_t *read_data);
j3 4:ca27db159b10 285
j3 4:ca27db159b10 286
j3 4:ca27db159b10 287 /**********************************************************//**
j3 4:ca27db159b10 288 * @brief Selected DS28E17's and send I2C address and poll until
j3 4:ca27db159b10 289 * I2C read address complete, receive status info, and read data
j3 4:ca27db159b10 290 * with a stop at the end.
j3 4:ca27db159b10 291 *
j3 4:ca27db159b10 292 * @details Output on I2C:
j3 4:ca27db159b10 293 * S, Slave Address + Read, Read Data [1-255], P (NACK last read byte)
j3 4:ca27db159b10 294 *
j3 4:ca27db159b10 295 * On Entry:
j3 4:ca27db159b10 296 * @param[in] I2C_addr
j3 4:ca27db159b10 297 * Writes I2C address. The least significant bit of the I2C address
j3 4:ca27db159b10 298 * is automatically cleared by the command.
j3 4:ca27db159b10 299 *
j3 4:ca27db159b10 300 * On Exit:
j3 4:ca27db159b10 301 * @param[out] nu_bytes_read
j3 4:ca27db159b10 302 * Number of I2C bytes to read. A value of zero will assert the Error Detected pin (ED).
j3 4:ca27db159b10 303 *
j3 4:ca27db159b10 304 * @param[out] status
j3 4:ca27db159b10 305 * Detects the condition of the Start (bit3), N/A (bit2),
j3 4:ca27db159b10 306 * Address(bit1) and CRC16(bit0) bits.
j3 4:ca27db159b10 307 * b3;0=No Err|1=I2CStart prev-not issued,
j3 4:ca27db159b10 308 * b2;0=No Err|1=I2C N/A Err,
j3 4:ca27db159b10 309 * b1;0=No Err|1=Addr Err,
j3 4:ca27db159b10 310 * b0;0=Valid CRC16|1=Invalid CRC16
j3 4:ca27db159b10 311 *
j3 4:ca27db159b10 312 * @param[out] wr_status
j3 4:ca27db159b10 313 * Indicates which write byte NACK’d. A value of 00h indicates all bytes were acknowledged by the slave.
j3 4:ca27db159b10 314 * A non-zero value indicates the byte number that NACK’d.
j3 4:ca27db159b10 315 *
j3 4:ca27db159b10 316 * @param[out] *read_data
j3 4:ca27db159b10 317 * Array of read data received from I2C.
j3 4:ca27db159b10 318 *
j3 4:ca27db159b10 319 * @return
j3 4:ca27db159b10 320 * true if device selected, written and read @n
j3 4:ca27db159b10 321 * false if failed device select or timeout occurred or CRC16 error
j3 4:ca27db159b10 322 **************************************************************/
j3 4:ca27db159b10 323 bool I2C_ReadDataWithStop(uint8_t I2C_addr, uint8_t nu_bytes_read,
j3 4:ca27db159b10 324 uint8_t status, uint8_t *read_data);
j3 4:ca27db159b10 325
j3 4:ca27db159b10 326
j3 4:ca27db159b10 327 /**********************************************************//**
j3 4:ca27db159b10 328 * @brief Write to Configuration Register of DS28E17.
j3 4:ca27db159b10 329 *
j3 4:ca27db159b10 330 * @details
j3 4:ca27db159b10 331 *
j3 4:ca27db159b10 332 * On Entry:
j3 4:ca27db159b10 333 * @param[in] data
j3 4:ca27db159b10 334 * sent to configuration register
j3 4:ca27db159b10 335 *
j3 4:ca27db159b10 336 * On Exit:
j3 4:ca27db159b10 337 *
j3 4:ca27db159b10 338 * @return
j3 4:ca27db159b10 339 * true if device selected and written @n
j3 4:ca27db159b10 340 * false if failed device select
j3 4:ca27db159b10 341 **************************************************************/
j3 4:ca27db159b10 342 bool WriteConfigReg(uint8_t data);
j3 4:ca27db159b10 343
j3 4:ca27db159b10 344
j3 4:ca27db159b10 345 /**********************************************************//**
j3 4:ca27db159b10 346 * @brief Read the Configuration Register of DS28E17.
j3 4:ca27db159b10 347 *
j3 4:ca27db159b10 348 * @details
j3 4:ca27db159b10 349 *
j3 4:ca27db159b10 350 * On Entry:
j3 4:ca27db159b10 351 *
j3 4:ca27db159b10 352 * On Exit:
j3 4:ca27db159b10 353 *
j3 4:ca27db159b10 354 * @return
j3 4:ca27db159b10 355 * device selected and read correctly @n
j3 4:ca27db159b10 356 * false if failed device select
j3 4:ca27db159b10 357 **************************************************************/
j3 4:ca27db159b10 358 uint8_t ReadConfigReg(void);
j3 4:ca27db159b10 359
j3 4:ca27db159b10 360
j3 4:ca27db159b10 361 /**********************************************************//**
j3 4:ca27db159b10 362 * @brief Disable 1-Wire Mode DS28E17 and activates the input detection pin.
j3 4:ca27db159b10 363 * Immediately after the command, all 1-Wire signaling will be ignored
j3 4:ca27db159b10 364 * until the 1W_DET pin is high for more than 3ms.
j3 4:ca27db159b10 365 *
j3 4:ca27db159b10 366 * @details
j3 4:ca27db159b10 367 *
j3 4:ca27db159b10 368 * On Entry:
j3 4:ca27db159b10 369 *
j3 4:ca27db159b10 370 * On Exit:
j3 4:ca27db159b10 371 *
j3 4:ca27db159b10 372 * @return
j3 4:ca27db159b10 373 * true if device selected and written @n
j3 4:ca27db159b10 374 * false if failed device select
j3 4:ca27db159b10 375 **************************************************************/
j3 4:ca27db159b10 376 bool DisableOWMode();
j3 4:ca27db159b10 377
j3 4:ca27db159b10 378
j3 4:ca27db159b10 379 /**********************************************************//**
j3 4:ca27db159b10 380 * @brief The Enable Sleep Mode command puts the device into a low current mode.
j3 4:ca27db159b10 381 * All 1-Wire communication is ignored until woken up. Immediately after
j3 4:ca27db159b10 382 * the command, the device monitors the WAKEUP input pin and
j3 4:ca27db159b10 383 * exits sleep mode on a rising edge.
j3 4:ca27db159b10 384 *
j3 4:ca27db159b10 385 * @details
j3 4:ca27db159b10 386 *
j3 4:ca27db159b10 387 * On Entry:
j3 4:ca27db159b10 388 *
j3 4:ca27db159b10 389 * On Exit:
j3 4:ca27db159b10 390 *
j3 4:ca27db159b10 391 * @return
j3 4:ca27db159b10 392 * true if device selected and written @n
j3 4:ca27db159b10 393 * false if failed device select*
j3 4:ca27db159b10 394 **************************************************************/
j3 4:ca27db159b10 395 bool EnableSleepMode();
j3 4:ca27db159b10 396
j3 4:ca27db159b10 397
j3 4:ca27db159b10 398 /**********************************************************//**
j3 4:ca27db159b10 399 * @brief Read the Device Revision of DS28E17. The revision value
j3 4:ca27db159b10 400 * should never be zero. The upper nibble is the major revision
j3 4:ca27db159b10 401 * and the lower nibble is the minor revision.
j3 4:ca27db159b10 402 *
j3 4:ca27db159b10 403 * @details
j3 4:ca27db159b10 404 *
j3 4:ca27db159b10 405 * On Entry:
j3 4:ca27db159b10 406 *
j3 4:ca27db159b10 407 * On Exit:
j3 4:ca27db159b10 408 *
j3 4:ca27db159b10 409 * @return
j3 4:ca27db159b10 410 * revision value if device selected and read correctly @n
j3 4:ca27db159b10 411 * false if failed device select (i.e. 00h)
j3 4:ca27db159b10 412 **************************************************************/
j3 4:ca27db159b10 413 uint8_t ReadDeviceRevision(void);
j3 4:ca27db159b10 414
j3 4:ca27db159b10 415 private:
j3 4:ca27db159b10 416
j3 4:ca27db159b10 417 OneWireInterface *_p_owm;
j3 4:ca27db159b10 418 bool _owm_owner;
j3 4:ca27db159b10 419 uint16_t _crc16;
j3 4:ca27db159b10 420 uint8_t _i2c_speed;
j3 4:ca27db159b10 421 static uint16_t _oddparity[16];
j3 4:ca27db159b10 422
j3 4:ca27db159b10 423 /**********************************************************//**
j3 4:ca27db159b10 424 * @brief Select the DS28E17 if rom number matches currently
j3 4:ca27db159b10 425 * selected device
j3 4:ca27db159b10 426 *
j3 4:ca27db159b10 427 * @details
j3 4:ca27db159b10 428 *
j3 4:ca27db159b10 429 * On Entry:
j3 4:ca27db159b10 430 *
j3 4:ca27db159b10 431 * On Exit:
j3 4:ca27db159b10 432 *
j3 4:ca27db159b10 433 * @return
j3 4:ca27db159b10 434 * true if device selected @n
j3 4:ca27db159b10 435 * false if problem occurred
j3 4:ca27db159b10 436 **************************************************************/
j3 4:ca27db159b10 437 bool DeviceSelect(void);
j3 4:ca27db159b10 438
j3 4:ca27db159b10 439
j3 4:ca27db159b10 440 /**********************************************************//**
j3 4:ca27db159b10 441 * @brief Calculate a new CRC16 from the input data shorteger.
j3 4:ca27db159b10 442 * Return the current CRC16 and also update the global variable CRC16.
j3 4:ca27db159b10 443 *
j3 4:ca27db159b10 444 * @details
j3 4:ca27db159b10 445 *
j3 4:ca27db159b10 446 * On Entry:
j3 4:ca27db159b10 447 *
j3 4:ca27db159b10 448 * On Exit:
j3 4:ca27db159b10 449 *
j3 4:ca27db159b10 450 * @return
j3 4:ca27db159b10 451 * CRC16
j3 4:ca27db159b10 452 **************************************************************/
j3 4:ca27db159b10 453 uint16_t docrc16(uint16_t data);
j3 4:ca27db159b10 454 };
j3 4:ca27db159b10 455
j3 4:ca27db159b10 456 #endif /*DS28E17_H*/