File tree Expand file tree Collapse file tree 2 files changed +11
-0
lines changed Expand file tree Collapse file tree 2 files changed +11
-0
lines changed Original file line number Diff line number Diff line change @@ -28,6 +28,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2828#pragma once
2929
3030#include " sfeTkError.h"
31+ #include < stddef.h>
3132
3233// Define our error codes for the bus. Note Errors are negative, warnings/info positive
3334// BUT keep the same increment on the base
Original file line number Diff line number Diff line change @@ -28,6 +28,12 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2828
2929#include " sfeTkIBus.h"
3030
31+ /* *
32+ * @brief Interface that defines the I2C communication bus for the SparkFun Electronics Toolkit.
33+ *
34+ * The I2C bus interface extends the IBus interface and adds the ability to set and get the I2C
35+ * address and stop flag.
36+ */
3137class sfeTkII2C : public sfeTkIBus
3238{
3339 public:
@@ -72,6 +78,7 @@ class sfeTkII2C : public sfeTkIBus
7278 /* --------------------------------------------------------------------------
7379 @brief setter for I2C stop message (vs restarts)
7480
81+ @param stop The value to set for "send stop"
7582 */
7683 virtual void setStop (bool stop)
7784 {
@@ -89,6 +96,9 @@ class sfeTkII2C : public sfeTkIBus
8996 return _stop;
9097 }
9198
99+ /*
100+ * @brief kNoAddress is a constant to indicate no address has been set
101+ */
92102 static constexpr uint8_t kNoAddress = 0 ;
93103
94104 private:
You can’t perform that action at this time.
0 commit comments