Added documentation, removed library from Makefile

Making the mqtt as a .a library is a project for a later date.
The recipe was broken and so was removed to avoid confusion.

Added the Mozilla License header to the new files. Also a few
small corrections and additions to the Doxygen documentation.

Signed-off-by: A.M. Rowsell <amrowsell@frozenelectronics.ca>
This commit is contained in:
A.M. Rowsell 2019-01-22 12:16:39 -05:00
commit 049573ad4b
Signed by: amr
GPG key ID: 0B6E2D8375CF79A9
4 changed files with 25 additions and 6 deletions

View file

@ -1,7 +1,16 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include <stdint.h>
#include "os_type.h"
#include "gpio.h"
/**
* @file
* @brief This is the header file for the one-wire library
*/
/**
* @struct oneWire_t
* Structure that holds all the information about onewire connections, including the 64-bit ROM address for each device and some buffer memory to read out the scratchpad
@ -29,5 +38,15 @@ typedef enum {
E2_RECALL = 0xB8
} ds18b20_cmds;
/**
* Function sends a reset pulse on the one-wire bus and checks for a presence pulse
* @return 0 if no presence, 1 if presence
*/
sint8 ICACHE_FLASH_ATTR reset(void);
/**
* Function which handles all one-wire communication besides the reset sequence.
* @param owDev A pointer to the oneWire_t variable for this device
* @param cmd One of the commands from ds18b20_cmds
*/
void ICACHE_FLASH_ATTR transact(oneWire_t *owDev, ds18b20_cmds cmd);