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.
Diff: Masters/OneWireMaster.h
- Revision:
- 74:23be10c32fa3
- Parent:
- 73:2cecc1372acc
- Child:
- 75:8b627804927c
diff -r 2cecc1372acc -r 23be10c32fa3 Masters/OneWireMaster.h --- a/Masters/OneWireMaster.h Thu May 12 14:38:16 2016 -0500 +++ b/Masters/OneWireMaster.h Fri May 13 07:48:35 2016 -0500 @@ -44,16 +44,15 @@ { /// Base class for all 1-Wire Masters. class OneWireMaster - { + { public: - /// Speed of the 1-Wire bus enum OWSpeed { SPEED_STANDARD = 0x00, SPEED_OVERDRIVE = 0x01 }; - + /// Level of the 1-Wire bus enum OWLevel { @@ -61,14 +60,14 @@ LEVEL_STRONG = 0x02, LEVEL_PROGRAM = 0x04, }; - + /// Search direction for the Triplet enum SearchDirection { DIRECTION_WRITE_ZERO = 0, DIRECTION_WRITE_ONE = 1 }; - + /// Result of all 1-Wire commands enum CmdResult { @@ -78,7 +77,7 @@ TimeoutError, OperationFailure }; - + /// State used by all ROM ID search functions. struct SearchState { @@ -86,7 +85,7 @@ uint8_t last_discrepancy; uint8_t last_family_discrepancy; bool last_device_flag; - + /// Reset to the search state to start at the beginning. void reset() { @@ -95,16 +94,16 @@ last_family_discrepancy = 0; romId.reset(); } - + SearchState() { reset(); } }; - + /// Perform a CRC16 calculation. /// @param CRC16 Beginning state of the CRC generator. /// @param data Data to pass though the CRC generator. /// @returns The calculated CRC16. static uint16_t calculateCRC16(uint16_t CRC16, uint16_t data); - + /// Perform a CRC16 calculation with variable length data. /// @param[in] data Data array to pass through the CRC generator. /// @param data_offset Offset of the data array to begin processing. @@ -112,14 +111,13 @@ /// @param crc Beginning state of the CRC generator. /// @returns The calculated CRC16. static uint16_t calculateCRC16(const uint8_t * data, size_t data_offset, size_t data_len, uint16_t crc = 0); - + /// Allow freeing through a base class pointer. virtual ~OneWireMaster() { } - - + /**********************************************************//** * @brief OWInitMaster() - * + * * @details Initiializes particular master being instaniated. * Added to interface to provide a common 'init' function between * all masters @@ -130,12 +128,11 @@ * **************************************************************/ virtual CmdResult OWInitMaster(void) = 0; - - + /**********************************************************//** * @brief OWReset() - * - * @details Reset all of the devices on the 1-Wire Net and return + * + * @details Reset all of the devices on the 1-Wire Net and return * the result. * * On Entry: @@ -146,15 +143,14 @@ * presence pulse was detected. **************************************************************/ virtual CmdResult OWReset(void) = 0; - - + /**********************************************************//** * @brief OWTouchBit() - * - * @details Send 1 bit of communication to the 1-Wire Net and return - * the result 1 bit read from the 1-Wire Net. The - * parameter 'sendbit' least significant bit is used and - * the least significant bit of the result is the return + * + * @details Send 1 bit of communication to the 1-Wire Net and return + * the result 1 bit read from the 1-Wire Net. The + * parameter 'sendbit' least significant bit is used and + * the least significant bit of the result is the return * bit. * * On Entry: @@ -164,14 +160,13 @@ * **************************************************************/ virtual CmdResult OWTouchBitSetLevel(uint8_t & sendrecvbit, OWLevel after_level) = 0; - - + /**********************************************************//** * @brief OWWRiteByte() - * - * @details Send 8 bits of communication to the 1-Wire Net and - * verify that the 8 bits read from the 1-Wire Net is the - * same (write operation).The parameter 'sendbyte' least + * + * @details Send 8 bits of communication to the 1-Wire Net and + * verify that the 8 bits read from the 1-Wire Net is the + * same (write operation).The parameter 'sendbyte' least * significant 8 bits are used. * * On Entry: @@ -181,12 +176,11 @@ * **************************************************************/ virtual CmdResult OWWriteByteSetLevel(uint8_t sendbyte, OWLevel after_level) = 0; - - + /**********************************************************//** * @brief OWReadByte() - * - * @details Send 8 bits of read communication to the 1-Wire Net + * + * @details Send 8 bits of read communication to the 1-Wire Net * and return the result 8 bits read from the 1-Wire Net. * * On Entry: @@ -195,12 +189,11 @@ * **************************************************************/ virtual CmdResult OWReadByteSetLevel(uint8_t & recvbyte, OWLevel after_level) = 0; - - + /**********************************************************//** * @brief OWWriteBlock() - * - * @details complements OWBlock, writes 'tran_len' bytes from + * + * @details complements OWBlock, writes 'tran_len' bytes from * 'tran_buf' to 1-wire Net. * * On Entry: @@ -211,12 +204,11 @@ * **************************************************************/ virtual CmdResult OWWriteBlock(const uint8_t *tran_buf, uint8_t tran_len); - - + /**********************************************************//** * @brief OWReadBlock() - * - * @details complements OWBlock, reads 'recv_len' bytes from + * + * @details complements OWBlock, reads 'recv_len' bytes from * 1-wire Net and puts them in 'recv_buf'. * * On Entry: @@ -224,14 +216,13 @@ * @param[in] recv_len - number of bytes to read * * On Exit: - * + * **************************************************************/ virtual CmdResult OWReadBlock(uint8_t *rx_buf, uint8_t rx_len); - - + /**********************************************************//** * @brief OWSetSpeed() - * + * * @details Set the 1-Wire Net communication speed. * * On Entry: @@ -243,16 +234,15 @@ * **************************************************************/ virtual CmdResult OWSetSpeed(OWSpeed new_speed) = 0; - - + /**********************************************************//** * @brief OWSetLevel() * - * @details Set the 1-Wire Net line level pull-up to normal. The - * ds2484 does only allows enabling strong pull-up on a - * bit or byte event. Consequently this function only - * allows the MODE_STANDARD argument. To enable strong - * pull-up use OWWriteBytePower or OWReadBitPower. + * @details Set the 1-Wire Net line level pull-up to normal. The + * ds2484 does only allows enabling strong pull-up on a + * bit or byte event. Consequently this function only + * allows the MODE_STANDARD argument. To enable strong + * pull-up use OWWriteBytePower or OWReadBitPower. * * On Entry: * @param[in] 'new_level' - new level defined as @@ -262,31 +252,30 @@ * **************************************************************/ virtual CmdResult OWSetLevel(OWLevel new_level) = 0; - - + /**********************************************************//** * @brief OWTriplet() - * + * * @details Perform one bit of a 1-Wire search. This command * does two read bits and one write bit. The write bit is either * the default direction (all device have same bit) or in case * of a discrepancy, the 'search_direction' parameter is used. - * + * * @param[in,out] search_direction * Input with desired direction in case both read bits are zero. * Output with direction taken based on read bits. - * + * * @param[out] sbr Bit result of first read operation. * @param[out] tsb Bit result of second read operation. **************************************************************/ virtual CmdResult OWTriplet(SearchDirection & search_direction, uint8_t & sbr, uint8_t & tsb); - + /// OWWriteBit() CmdResult OWWriteBitSetLevel(uint8_t sendbit, OWLevel after_level) { return OWTouchBitSetLevel(sendbit, after_level); } - + /// OWReadBit() CmdResult OWReadBitSetLevel(uint8_t & recvbit, OWLevel after_level) { recvbit = 0x01; return OWTouchBitSetLevel(recvbit, after_level); } - + // Alternate forms of read and write functions CmdResult OWWriteBit(uint8_t sendbit) { return OWWriteBitSetLevel(sendbit, LEVEL_NORMAL); } CmdResult OWReadBit(uint8_t & recvbit) { return OWReadBitSetLevel(recvbit, LEVEL_NORMAL); } @@ -296,10 +285,10 @@ CmdResult OWReadByte(uint8_t & recvbyte) { return OWReadByteSetLevel(recvbyte, LEVEL_NORMAL); } CmdResult OWWriteBytePower(uint8_t sendbyte) { return OWWriteByteSetLevel(sendbyte, LEVEL_STRONG); } CmdResult OWReadBytePower(uint8_t & recvbyte) { return OWReadByteSetLevel(recvbyte, LEVEL_STRONG); } - + /**********************************************************//** * @brief OWFirst() - * + * * @details Find the 'first' devices on the 1-Wire network * * On Entry: @@ -308,10 +297,10 @@ * **************************************************************/ CmdResult OWFirst(SearchState & searchState); - + /**********************************************************//** * @brief OWNext() - * + * * @details Find the 'next' devices on the 1-Wire network * * On Entry: @@ -320,11 +309,11 @@ * **************************************************************/ CmdResult OWNext(SearchState & searchState); - + /**********************************************************//** * @brief OWVerify() - * - * @details Verify the device with the ROM number in ROM_NO buffer + * + * @details Verify the device with the ROM number in ROM_NO buffer * is present. * * On Entry: @@ -333,11 +322,11 @@ * **************************************************************/ CmdResult OWVerify(const RomId & romId); - + /**********************************************************//** * @brief OWTargetSetup() - * - * @details Setup the search to find the device type 'family_code' + * + * @details Setup the search to find the device type 'family_code' * on the next call to OWNext() if it is present. * * On Entry: @@ -347,11 +336,11 @@ * **************************************************************/ void OWTargetSetup(SearchState & searchState); - + /**********************************************************//** * @brief OWFamilySkipSetup() - * - * @details Setup the search to skip the current device type on the + * + * @details Setup the search to skip the current device type on the * next call to OWNext(). * * On Entry: @@ -360,10 +349,10 @@ * **************************************************************/ void OWFamilySkipSetup(SearchState & searchState); - + /**********************************************************//** * @brief OWReadROM() - * + * * @details Only use this command with a single drop bus, data * collisions will occur if more than 1 device on bus. * Issues READ_ROM command, slave device will respond with ROM ID. @@ -374,10 +363,10 @@ * **************************************************************/ CmdResult OWReadROM(RomId & romId); - + /**********************************************************//** * @brief OWSkipROM() - * + * * @details Issue SKIP_ROM command on 1-wire bus * * On Entry: @@ -386,10 +375,10 @@ * **************************************************************/ CmdResult OWSkipROM(void); - + /**********************************************************//** * @brief OWMatchROM() - * + * * @details Issues MATCH_ROM command on 1-wire bus and then sends * the rom id in _rom_number * @@ -399,11 +388,11 @@ * **************************************************************/ CmdResult OWMatchROM(const RomId & romId); - + /**********************************************************//** * @brief OWOverdriveSkipROM() - * - * @details Issues OVERDRIVE_SKIP rom command. DS248X OW speed + * + * @details Issues OVERDRIVE_SKIP rom command. DS248X OW speed * is set to SPEED_OVERDRIVE * * On Entry: @@ -412,11 +401,11 @@ * **************************************************************/ CmdResult OWOverdriveSkipROM(void); - + /**********************************************************//** * @brief OWOverdriveMatchROM() - * - * @details Issues OVERDRIVE_MATCH rom command. DS248X OW speed + * + * @details Issues OVERDRIVE_MATCH rom command. DS248X OW speed * is set to SPEED_OVERDRIVE * * On Entry: @@ -425,14 +414,14 @@ * **************************************************************/ CmdResult OWOverdriveMatchROM(const RomId & romId); - + /**********************************************************//** * @brief OWResume() - * - * @details Issues RESUME command, very usefull. Is like skip - * on a multidrop bus, however you must first select the device - * you want to interface with using a MATCH, or SEARCH. The - * device stays selected until another device is selected, + * + * @details Issues RESUME command, very usefull. Is like skip + * on a multidrop bus, however you must first select the device + * you want to interface with using a MATCH, or SEARCH. The + * device stays selected until another device is selected, * see slave datasheet for detailed explanation. * * On Entry: @@ -441,18 +430,18 @@ * **************************************************************/ CmdResult OWResume(void); - + /**********************************************************//** * @brief OWSearch() - * - * @details The 'OWSearch' function does a general search. This - * function continues from the previous search state. The - * search state can be reset by using the 'OWFirst' - * function. This function contains one parameter - * 'alarm_only'. When 'alarm_only' is TRUE (1) the find - * alarm command 0xEC is sent instead of the normal search - * command 0xF0. Using the find alarm command 0xEC will - * limit the search to only 1-Wire devices that are in an + * + * @details The 'OWSearch' function does a general search. This + * function continues from the previous search state. The + * search state can be reset by using the 'OWFirst' + * function. This function contains one parameter + * 'alarm_only'. When 'alarm_only' is TRUE (1) the find + * alarm command 0xEC is sent instead of the normal search + * command 0xF0. Using the find alarm command 0xEC will + * limit the search to only 1-Wire devices that are in an * 'alarm' state. * * On Entry: @@ -465,4 +454,4 @@ } } -#endif /*ONEWIREMASTER_H*/ +#endif