Maxim Integrated / OneWire

1-Wire® library for mbed. Complete 1-Wire library that supports our silicon masters along with a bit-bang master on the MAX32600MBED platform with one common interface for mbed. Slave support has also been included and more slaves will be added as time permits.

Dependents:   MAXREFDES131_Qt_Demo MAX32630FTHR_iButton_uSD_Logger MAX32630FTHR_DS18B20_uSD_Logger MAXREFDES130_131_Demo ... more

Superseded by MaximInterface.

OneWire_Masters/DS2480B/ds2480b.h@3:644fc630f958, 2016-01-31 (annotated)

Committer:
j3
Date:
Sun Jan 31 22:42:01 2016 +0000
Revision:
3:644fc630f958
Child:
5:ce108eeb878d
DS248X masters implemented, skeletons for the others, working on porting code for the DS28E17 1-wire to I2C bridge

Who changed what in which revision?

UserRevisionLine numberNew contents of line
j3 3:644fc630f958 1 /******************************************************************//**
j3 3:644fc630f958 2 * @file ds2480b.h
j3 3:644fc630f958 3 *
j3 3:644fc630f958 4 * @author Justin Jordan
j3 3:644fc630f958 5 *
j3 3:644fc630f958 6 * @version 0.0.0
j3 3:644fc630f958 7 *
j3 3:644fc630f958 8 * Started: 31JAN16
j3 3:644fc630f958 9 *
j3 3:644fc630f958 10 * Updated:
j3 3:644fc630f958 11 *
j3 3:644fc630f958 12 * @brief Header file for DS2480B Async Serial to 1-wire master
j3 3:644fc630f958 13 ***********************************************************************
j3 3:644fc630f958 14 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
j3 3:644fc630f958 15 *
j3 3:644fc630f958 16 * Permission is hereby granted, free of charge, to any person obtaining a
j3 3:644fc630f958 17 * copy of this software and associated documentation files (the "Software"),
j3 3:644fc630f958 18 * to deal in the Software without restriction, including without limitation
j3 3:644fc630f958 19 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
j3 3:644fc630f958 20 * and/or sell copies of the Software, and to permit persons to whom the
j3 3:644fc630f958 21 * Software is furnished to do so, subject to the following conditions:
j3 3:644fc630f958 22 *
j3 3:644fc630f958 23 * The above copyright notice and this permission notice shall be included
j3 3:644fc630f958 24 * in all copies or substantial portions of the Software.
j3 3:644fc630f958 25 *
j3 3:644fc630f958 26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
j3 3:644fc630f958 27 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
j3 3:644fc630f958 28 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
j3 3:644fc630f958 29 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
j3 3:644fc630f958 30 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
j3 3:644fc630f958 31 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
j3 3:644fc630f958 32 * OTHER DEALINGS IN THE SOFTWARE.
j3 3:644fc630f958 33 *
j3 3:644fc630f958 34 * Except as contained in this notice, the name of Maxim Integrated
j3 3:644fc630f958 35 * Products, Inc. shall not be used except as stated in the Maxim Integrated
j3 3:644fc630f958 36 * Products, Inc. Branding Policy.
j3 3:644fc630f958 37 *
j3 3:644fc630f958 38 * The mere transfer of this software does not imply any licenses
j3 3:644fc630f958 39 * of trade secrets, proprietary technology, copyrights, patents,
j3 3:644fc630f958 40 * trademarks, maskwork rights, or any other form of intellectual
j3 3:644fc630f958 41 * property whatsoever. Maxim Integrated Products, Inc. retains all
j3 3:644fc630f958 42 * ownership rights.
j3 3:644fc630f958 43 **********************************************************************/
j3 3:644fc630f958 44
j3 3:644fc630f958 45
j3 3:644fc630f958 46 #ifndef DS2480B_H
j3 3:644fc630f958 47 #define DS2480B_H
j3 3:644fc630f958 48
j3 3:644fc630f958 49
j3 3:644fc630f958 50 #include "mbed.h"
j3 3:644fc630f958 51 #include "OneWireInterface.h"
j3 3:644fc630f958 52
j3 3:644fc630f958 53
j3 3:644fc630f958 54 class Ds2480b: public OneWireInterface
j3 3:644fc630f958 55 {
j3 3:644fc630f958 56 public:
j3 3:644fc630f958 57
j3 3:644fc630f958 58 /**********************************************************//**
j3 3:644fc630f958 59 * @brief Ds2480b constructor
j3 3:644fc630f958 60 *
j3 3:644fc630f958 61 * @details allows user to use existing Serial object
j3 3:644fc630f958 62 *
j3 3:644fc630f958 63 * On Entry:
j3 3:644fc630f958 64 * @param[in] p_serial - pointer to existing serial object
j3 3:644fc630f958 65 *
j3 3:644fc630f958 66 * On Exit:
j3 3:644fc630f958 67 * @return
j3 3:644fc630f958 68 **************************************************************/
j3 3:644fc630f958 69 Ds2480b(Serial *p_serial);
j3 3:644fc630f958 70
j3 3:644fc630f958 71
j3 3:644fc630f958 72 /**********************************************************//**
j3 3:644fc630f958 73 * @brief Ds2480b constructor
j3 3:644fc630f958 74 *
j3 3:644fc630f958 75 * @details Object instantiates a new serial object with no
j3 3:644fc630f958 76 * public access
j3 3:644fc630f958 77 *
j3 3:644fc630f958 78 * On Entry:
j3 3:644fc630f958 79 * @param[in] tx - tx pin of uart to be used
j3 3:644fc630f958 80 * @param[in] rx - rx pin of uart to be used
j3 3:644fc630f958 81 * @param[in] baud - baudrate for uart
j3 3:644fc630f958 82 *
j3 3:644fc630f958 83 * On Exit:
j3 3:644fc630f958 84 * @return
j3 3:644fc630f958 85 **************************************************************/
j3 3:644fc630f958 86 Ds2480b(PinName tx, PinName rx, uint32_t baud);
j3 3:644fc630f958 87
j3 3:644fc630f958 88
j3 3:644fc630f958 89 /**********************************************************//**
j3 3:644fc630f958 90 * @brief Ds2480b destructor
j3 3:644fc630f958 91 *
j3 3:644fc630f958 92 * @details deletes serial object if owner
j3 3:644fc630f958 93 *
j3 3:644fc630f958 94 * On Entry:
j3 3:644fc630f958 95 *
j3 3:644fc630f958 96 * On Exit:
j3 3:644fc630f958 97 * @return
j3 3:644fc630f958 98 **************************************************************/
j3 3:644fc630f958 99 ~Ds2480b();
j3 3:644fc630f958 100
j3 3:644fc630f958 101
j3 3:644fc630f958 102 /***** OW API ****************************************************/
j3 3:644fc630f958 103 virtual bool OWReset();
j3 3:644fc630f958 104
j3 3:644fc630f958 105 virtual void OWWriteBit(uint8_t sendbit);
j3 3:644fc630f958 106
j3 3:644fc630f958 107 virtual uint8_t OWReadBit();
j3 3:644fc630f958 108
j3 3:644fc630f958 109 virtual uint8_t OWTouchBit(uint8_t sendbit);
j3 3:644fc630f958 110
j3 3:644fc630f958 111 virtual bool OWWriteByte(uint8_t sendbyte);
j3 3:644fc630f958 112
j3 3:644fc630f958 113 virtual uint8_t OWReadByte(void);
j3 3:644fc630f958 114
j3 3:644fc630f958 115 virtual uint8_t OWTouchByte(uint8_t sendbyte);
j3 3:644fc630f958 116
j3 3:644fc630f958 117 virtual void OWBlock(uint8_t *tran_buf, uint8_t tran_len);
j3 3:644fc630f958 118
j3 3:644fc630f958 119 virtual bool OWFirst(void);
j3 3:644fc630f958 120
j3 3:644fc630f958 121 virtual bool OWNext(void);
j3 3:644fc630f958 122
j3 3:644fc630f958 123 virtual bool OWVerify(void);
j3 3:644fc630f958 124
j3 3:644fc630f958 125 virtual void OWTargetSetup(uint8_t family_code);
j3 3:644fc630f958 126
j3 3:644fc630f958 127 virtual void OWFamilySkipSetup(void);
j3 3:644fc630f958 128
j3 3:644fc630f958 129 virtual bool OWSearch(void);
j3 3:644fc630f958 130
j3 3:644fc630f958 131 virtual uint8_t OWSpeed(uint8_t new_speed);
j3 3:644fc630f958 132
j3 3:644fc630f958 133 virtual uint8_t OWLevel(uint8_t new_level);
j3 3:644fc630f958 134
j3 3:644fc630f958 135 virtual bool OWWriteBytePower(uint8_t sendbyte);
j3 3:644fc630f958 136
j3 3:644fc630f958 137 virtual bool OWReadBitPower(uint8_t applyPowerResponse);
j3 3:644fc630f958 138
j3 3:644fc630f958 139 virtual uint8_t OWCalc_crc8(uint8_t data);
j3 3:644fc630f958 140
j3 3:644fc630f958 141 virtual void OWgetROMnumber(uint8_t *p_rom_buff);
j3 3:644fc630f958 142
j3 3:644fc630f958 143 private:
j3 3:644fc630f958 144
j3 3:644fc630f958 145 Serial *_p_serial;
j3 3:644fc630f958 146 bool _serial_owner;
j3 3:644fc630f958 147 };
j3 3:644fc630f958 148
j3 3:644fc630f958 149 #endif /*DS2480B_H*/
j3 3:644fc630f958 150