Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: MAXREFDES131_Qt_Demo MAX32630FTHR_iButton_uSD_Logger MAX32630FTHR_DS18B20_uSD_Logger MAXREFDES130_131_Demo ... more
OneWire::RomCommands Namespace Reference
Procedural 1-Wire ROM Commands for enumerating and selecting devices. More...
Data Structures | |
| struct | SearchState |
| State used by all ROM ID search functions. More... | |
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
Procedural 1-Wire ROM Commands for enumerating and selecting devices.
Function Documentation
| OneWireMaster::CmdResult OWAlarmSearch | ( | OneWireMaster & | master, |
| SearchState & | searchState | ||
| ) |
Find Alarming Devices on 1-Wire bus.
This command uses the Alarm Search ROM command to enumerate all 1-Wire devices with active alarms Begin with a new search state and continue using the same search state until the last device flag is set which indicates that all devices have been discovered.
Definition at line 246 of file RomCommands.cpp.
| OneWireMaster::CmdResult OWFirst | ( | OneWireMaster & | master, |
| SearchState & | searchState | ||
| ) |
Find the 'first' devices on the 1-Wire bus.
Definition at line 83 of file RomCommands.cpp.
| OneWireMaster::CmdResult OWFirstAlarm | ( | OneWireMaster & | master, |
| SearchState & | searchState | ||
| ) |
Find the first Alarming device on the 1-Wire bus.
This command resets the SearchState and uses the Alarm Search command to enumerate the first actively alarming device on the bus, in numerical order by ROM ID.
Definition at line 251 of file RomCommands.cpp.
| OneWireMaster::CmdResult OWMatchRom | ( | OneWireMaster & | master, |
| const RomId & | romId | ||
| ) |
Use the Match ROM command to select the device by its known ID.
- Note:
- This command causes all devices supporting Overdrive mode to switch to Overdrive timing.
- Parameters:
-
[in] romId ROM ID of device to select.
Definition at line 166 of file RomCommands.cpp.
| OneWireMaster::CmdResult OWNext | ( | OneWireMaster & | master, |
| SearchState & | searchState | ||
| ) |
Find the 'next' devices on the 1-Wire bus.
Definition at line 90 of file RomCommands.cpp.
| OneWireMaster::CmdResult OWNextAlarm | ( | OneWireMaster & | master, |
| SearchState & | searchState | ||
| ) |
Find the next Alarming Device on the 1-Wire bus.
This command uses the Alarm Search command to enumerate the next actively alarming device on the bus, which is determined by the current searchState.
Definition at line 257 of file RomCommands.cpp.
| OneWireMaster::CmdResult OWOverdriveMatchRom | ( | OneWireMaster & | master, |
| const RomId & | romId | ||
| ) |
Use the Overdrive Match ROM command to select the device by its known ID.
- Parameters:
-
[in] romId ROM ID of device to select.
Definition at line 207 of file RomCommands.cpp.
| OneWireMaster::CmdResult OWOverdriveSkipRom | ( | OneWireMaster & | master ) |
Issue Overdrive Skip ROM command on bus.
- Note:
- This command causes all devices supporting Overdrive mode to switch to Overdrive timing.
- Only use this command with a single drop bus, data collisions will occur if more than 1 device on bus.
Definition at line 185 of file RomCommands.cpp.
| OneWireMaster::CmdResult OWReadRom | ( | OneWireMaster & | master, |
| RomId & | romId | ||
| ) |
Use Read ROM command to read ROM ID from device on bus.
- Note:
- Only use this command with a single drop bus, data collisions will occur if more than 1 device on bus.
- Parameters:
-
[out] romId ROM ID read from device.
Definition at line 120 of file RomCommands.cpp.
| OneWireMaster::CmdResult OWResume | ( | OneWireMaster & | master ) |
Perform a Resume ROM command on bus.
Resumes communication with the last device selected though a Match ROM or Search ROM operation.
Definition at line 228 of file RomCommands.cpp.
| OneWireMaster::CmdResult OWSearch | ( | OneWireMaster & | master, |
| SearchState & | searchState | ||
| ) |
Find device on the 1-Wire bus.
This command uses the Search ROM command to enumerate all 1-Wire devices in sequence. Begin with a new search state and continue using the same search state until the last device flag is set which indicates that all devices have been discovered.
Definition at line 241 of file RomCommands.cpp.
| OneWireMaster::CmdResult OWSearchAll | ( | OneWireMaster & | master, |
| SearchState & | searchState, | ||
| bool | alarmSearch | ||
| ) |
Helper function for the above search functions.
Definition at line 262 of file RomCommands.cpp.
| OneWireMaster::CmdResult OWSkipRom | ( | OneWireMaster & | master ) |
Issue Skip ROM command on bus.
- Note:
- Only use this command with a single drop bus, data collisions will occur if more than 1 device on bus.
Definition at line 153 of file RomCommands.cpp.
| OneWireMaster::CmdResult OWVerify | ( | OneWireMaster & | master, |
| const RomId & | romId | ||
| ) |
Verify that the device with the specified ROM ID is present.
Definition at line 96 of file RomCommands.cpp.
Generated on Tue Jul 12 2022 15:46:21 by
1.7.2