Easyuino  1.2.0
Utilities.h
1 /*
2 MIT License
3 
4 Copyright (c) 2017 André Pires
5 
6 Permission is hereby granted, free of charge, to any person obtaining a copy
7 of this software and associated documentation files (the "Software"), to deal
8 in the Software without restriction, including without limitation the rights
9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 copies of the Software, and to permit persons to whom the Software is
11 furnished to do so, subject to the following conditions:
12 
13 The above copyright notice and this permission notice shall be included in all
14 copies or substantial portions of the Software.
15 
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 SOFTWARE.
23 */
24 /*
25 Utilities.h
26 */
27 #ifndef _EASYUINO_UTILITIES_h
28 #define _EASYUINO_UTILITIES_h
29 
30 #include <Wire.h>
31 #include <string.h>
32 #include <stdlib.h>
33 
35 #define IN
36 
37 #define OUT
38 
39 #define INOUT
40 
41 namespace Easyuino {
42 
46  class Utilities {
47 
48  public:
54  static void* EasyMalloc(IN unsigned int sizeInBytes);
55 
60  static void ZeroBuffer(IN void *buffer, IN size_t bufferSize);
61 
65  static void OverrideLastStringChar(IN char* string);
66 
70  static void OverrideLastTwoChar(IN char* string);
71 
77  static void ObtainI2CDeviceAddress(INOUT int* listOfAddresses, IN uint8_t sizeOfList);
78 
79  };
80 
81 };
82 
83 #endif
static void OverrideLastStringChar(IN char *string)
Put a \0 in the last character of the string.
static void ObtainI2CDeviceAddress(INOUT int *listOfAddresses, IN uint8_t sizeOfList)
Obtain the addresses of all devices connected to Arduino using I2C.
static void OverrideLastTwoChar(IN char *string)
Put a \0 in the last two characters of the string.
Definition: Button.h:38
static void * EasyMalloc(IN unsigned int sizeInBytes)
Wrapper around the stdlib.h malloc to make it safe of overflows in the the majority of common string ...
static void ZeroBuffer(IN void *buffer, IN size_t bufferSize)
Fills a given buffer with zeros aka \0.
Provides some auxiliary functions for internal use in library but at same time expose it to public fo...
Definition: Utilities.h:46