cMicroOrp  1.0.0
C code for microcontrollers - provides ORP remote interface
orp_input.h
Go to the documentation of this file.
1 /*
2 Copyright <2020> <J Thompson>
3 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
5 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
6 */
7 
8 #ifndef ORP_INPUT_H
9 #define ORP_INPUT_H
10 
11 #ifdef __cplusplus
12 extern "C" {
13 #endif
14 
15 
16 
17 
18 // The input registration request
19 // ----------------------------------------------------------------------------
25 // ----------------------------------------------------------------------------
26 int8_t orp_input_registerJson(char *keyString);
27 
28 // The Octave input data send Remote device --> Octave Edge device
29 // ----------------------------------------------------------------------------
36 // ----------------------------------------------------------------------------
37 int8_t orp_input_sendJson( char *keyString , char * valueString);
38 
39 
40 // The input registration request
41 // ----------------------------------------------------------------------------
47 // ----------------------------------------------------------------------------
48 int8_t orp_input_sendNumeric ( char * keyString, char * valueString);
49 
50 // The Octave input data send Remote device --> Octave Edge device
51 // ----------------------------------------------------------------------------
58 // ----------------------------------------------------------------------------
59 int8_t orp_input_registerNumeric ( char * keyString);
60 
61 #ifdef __cplusplus
62 }
63 #endif
64 
65 #endif // ORP_INPUT_H
orp_input_registerJson
int8_t orp_input_registerJson(char *keyString)
Register a JSON input in Octave Remote.
Definition: orp_input.c:24
orp_input_sendJson
int8_t orp_input_sendJson(char *keyString, char *valueString)
Sends a JSON string to Octave Remote input.
Definition: orp_input.c:43
orp_input_registerNumeric
int8_t orp_input_registerNumeric(char *keyString)
Sends a numeric value to Octave Remote input.
Definition: orp_input.c:60
orp_input_sendNumeric
int8_t orp_input_sendNumeric(char *keyString, char *valueString)
Register a numeric input in Octave Remote.
Definition: orp_input.c:80