![]() |
MAX32665 SDK Documentation
0.2
Software Development Kit Overview and API Documentation
|
Modules | |
OWM_Registers | |
Registers, Bit Masks and Bit Positions for the OWM Peripheral Module. | |
Data Structures | |
struct | owm_cfg_t |
Structure type for 1-Wire Master configuration. More... | |
Macros | |
#define | READ_ROM_COMMAND 0x33 |
Read ROM Command. | |
#define | MATCH_ROM_COMMAND 0x55 |
Match ROM Command. | |
#define | SEARCH_ROM_COMMAND 0xF0 |
Search ROM Command. | |
#define | SKIP_ROM_COMMAND 0xCC |
Skip ROM Command. | |
#define | OD_SKIP_ROM_COMMAND 0x3C |
Overdrive Skip ROM Command. | |
#define | OD_MATCH_ROM_COMMAND 0x69 |
Overdrive Match ROM Command. | |
#define | RESUME_COMMAND 0xA5 |
Resume Command. | |
Enumerations | |
enum | owm_ext_pu_t { OWM_EXT_PU_ACT_HIGH = 0, OWM_EXT_PU_ACT_LOW = 1, OWM_EXT_PU_UNUSED = 2 } |
Enumeration type for specifying options for 1-Wire external pullup mode. More... | |
Functions | |
int | OWM_Init (const owm_cfg_t *cfg, const sys_cfg_owm_t *sys_cfg) |
Initialize and enable OWM module. More... | |
void | OWM_Shutdown (void) |
Shutdown OWM module. | |
int | OWM_Reset (void) |
Send 1-Wire reset pulse. More... | |
int | OWM_TouchByte (uint8_t data) |
Send and receive one byte of data. More... | |
int | OWM_WriteByte (uint8_t data) |
Write one byte of data. More... | |
int | OWM_ReadByte (void) |
Read one byte of data. More... | |
int | OWM_TouchBit (uint8_t bit) |
Send and receive one bit of data. More... | |
int | OWM_WriteBit (uint8_t bit) |
Write one bit of data. More... | |
int | OWM_ReadBit (void) |
Read one bit of data. More... | |
int | OWM_Write (uint8_t *data, int len) |
Write multiple bytes of data. More... | |
int | OWM_Read (uint8_t *data, int len) |
Read multiple bytes of data. More... | |
int | OWM_ReadROM (uint8_t *ROMCode) |
Starts 1-Wire communication with Read ROM command. More... | |
int | OWM_MatchROM (uint8_t *ROMCode) |
Starts 1-Wire communication with Match ROM command. More... | |
int | OWM_ODMatchROM (uint8_t *ROMCode) |
Starts 1-Wire communication with Overdrive Match ROM command. More... | |
int | OWM_SkipROM (void) |
Starts 1-Wire communication with Skip ROM command. More... | |
int | OWM_ODSkipROM (void) |
Starts 1-Wire communication with Overdrive Skip ROM command. More... | |
int | OWM_Resume (void) |
Starts 1-Wire communication with Resume command. More... | |
int | OWM_SearchROM (int newSearch, uint8_t *ROMCode) |
Starts 1-Wire communication with Search ROM command. More... | |
void | OWM_ClearFlags (uint32_t mask) |
Clear interrupt flags. More... | |
unsigned | OWM_GetFlags (void) |
Get interrupt flags. More... | |
void | OWM_SetExtPullup (int enable) |
Enables/Disables the External pullup. More... | |
void | OWM_SetOverdrive (int enable) |
Enables/Disables Overdrive speed. More... | |
enum owm_ext_pu_t |
int OWM_Init | ( | const owm_cfg_t * | cfg, |
const sys_cfg_owm_t * | sys_cfg | ||
) |
cfg | Pointer to OWM configuration. |
sys_cfg | System configuration object |
int OWM_Reset | ( | void | ) |
Will block until transaction is complete.
int OWM_TouchByte | ( | uint8_t | data | ) |
Will block until transaction is complete.
data | data to send |
int OWM_WriteByte | ( | uint8_t | data | ) |
Will block until transaction is complete.
data | data to send |
int OWM_ReadByte | ( | void | ) |
Will block until transaction is complete.
int OWM_TouchBit | ( | uint8_t | bit | ) |
Will block until transaction is complete.
bit | bit to send |
int OWM_WriteBit | ( | uint8_t | bit | ) |
Will block until transaction is complete.
bit | bit to send |
int OWM_ReadBit | ( | void | ) |
Will block until transaction is complete.
int OWM_Write | ( | uint8_t * | data, |
int | len | ||
) |
Will block until transaction is complete.
data | Pointer to buffer for write data. |
len | Number of bytes to write. |
int OWM_Read | ( | uint8_t * | data, |
int | len | ||
) |
Will block until transaction is complete.
data | Pointer to buffer for read data. |
len | Number of bytes to read. |
int OWM_ReadROM | ( | uint8_t * | ROMCode | ) |
ROMCode | Pointer to buffer for ROM code read |
int OWM_MatchROM | ( | uint8_t * | ROMCode | ) |
ROMCode | Pointer to buffer with ROM code to match |
int OWM_ODMatchROM | ( | uint8_t * | ROMCode | ) |
ROMCode | Pointer to buffer with ROM code to match |
int OWM_SkipROM | ( | void | ) |
int OWM_ODSkipROM | ( | void | ) |
int OWM_Resume | ( | void | ) |
int OWM_SearchROM | ( | int | newSearch, |
uint8_t * | ROMCode | ||
) |
newSearch | (1) = start new search, (0) = continue search for next ROM |
ROMCode | Pointer to buffer with ROM code found |
void OWM_ClearFlags | ( | uint32_t | mask | ) |
mask | Mask of interrupts to clear. |
unsigned OWM_GetFlags | ( | void | ) |
void OWM_SetExtPullup | ( | int | enable | ) |
enable | (1) = enable, (0) = disable |
void OWM_SetOverdrive | ( | int | enable | ) |
enable | (1) = overdrive, (0) = standard |