Implementation of 1-Wire with added Alarm Search Functionality

Dependents:   Max32630_One_Wire_Interface

Embed: (wiki syntax)

« Back to documentation index

RomCommands.h File Reference

RomCommands.h File Reference

Go to the source code of this file.

Data Structures

struct  SearchState
 State used by all ROM ID search functions. More...

Namespaces

namespace  OneWire
 

Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.


namespace  OneWire::RomCommands
 

Procedural 1-Wire ROM Commands for enumerating and selecting devices.


Functions

OneWireMaster::CmdResult OWFirst (OneWireMaster &master, SearchState &searchState)
 Find the 'first' devices on the 1-Wire bus.
OneWireMaster::CmdResult OWNext (OneWireMaster &master, SearchState &searchState)
 Find the 'next' devices on the 1-Wire bus.
OneWireMaster::CmdResult OWVerify (OneWireMaster &master, const RomId &romId)
 Verify that the device with the specified ROM ID is present.
OneWireMaster::CmdResult OWReadRom (OneWireMaster &master, RomId &romId)
 Use Read ROM command to read ROM ID from device on bus.
OneWireMaster::CmdResult OWSkipRom (OneWireMaster &master)
 Issue Skip ROM command on bus.
OneWireMaster::CmdResult OWMatchRom (OneWireMaster &master, const RomId &romId)
 Use the Match ROM command to select the device by its known ID.
OneWireMaster::CmdResult OWOverdriveSkipRom (OneWireMaster &master)
 Issue Overdrive Skip ROM command on bus.
OneWireMaster::CmdResult OWOverdriveMatchRom (OneWireMaster &master, const RomId &romId)
 Use the Overdrive Match ROM command to select the device by its known ID.
OneWireMaster::CmdResult OWResume (OneWireMaster &master)
 Perform a Resume ROM command on bus.
OneWireMaster::CmdResult OWSearch (OneWireMaster &master, SearchState &searchState)
 Find device on the 1-Wire bus.
OneWireMaster::CmdResult OWAlarmSearch (OneWireMaster &master, SearchState &searchState)
 Find Alarming Devices on 1-Wire bus.
OneWireMaster::CmdResult OWFirstAlarm (OneWireMaster &master, SearchState &searchState)
 Find the first Alarming device on the 1-Wire bus.
OneWireMaster::CmdResult OWNextAlarm (OneWireMaster &master, SearchState &searchState)
 Find the next Alarming Device on the 1-Wire bus.
OneWireMaster::CmdResult OWSearchAll (OneWireMaster &master, SearchState &searchState, bool alarmSearch)
 Helper function for the above search functions.

Detailed Description

Definition in file RomCommands.h.