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@17:b646b1e3970b, 2016-03-18 (annotated)

Committer:
j3
Date:
Fri Mar 18 20:21:05 2016 +0000
Revision:
17:b646b1e3970b
Parent:
16:883becbd85f8
Child:
23:e8e403d61359
Updated library with error codes on return statements

Who changed what in which revision?

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