cMicroOrp  1.0.0
C code for microcontrollers - provides ORP remote interface
orp_input.c File Reference
#include "orp.h"
#include <stdio.h>

Functions

int8_t orp_input_registerJson (char *keyString)
 Register a JSON input in Octave Remote. More...
 
int8_t orp_input_sendJson (char *keyString, char *valueString)
 Sends a JSON string to Octave Remote input. More...
 
int8_t orp_input_registerNumeric (char *keyString)
 Sends a numeric value to Octave Remote input. More...
 
int8_t orp_input_sendNumeric (char *keyString, char *valueString)
 Register a numeric input in Octave Remote. More...
 

Function Documentation

◆ orp_input_registerJson()

int8_t orp_input_registerJson ( char *  keyString)

Register a JSON input in Octave Remote.

Parameters
keyStringNull terminated string that contains the remote path
Returns
A value of orpProtocol_txBuffer_size or more means that the output was truncated
See also
orp_protocol()

◆ orp_input_registerNumeric()

int8_t orp_input_registerNumeric ( char *  keyString)

Sends a numeric value to Octave Remote input.

Parameters
keyStringNull terminated string that contains the remote path
valueStringNull terminated string that represents a numeric value (see Octave docs)
Returns
A value of orpProtocol_txBuffer_size or more means that the output was truncated
See also
orp_protocol()

◆ orp_input_sendJson()

int8_t orp_input_sendJson ( char *  keyString,
char *  valueString 
)

Sends a JSON string to Octave Remote input.

Parameters
keyStringNull terminated string that contains the remote path
valueStringNull terminated string that represents a JSON value (see Octave docs)
Returns
A value of orpProtocol_txBuffer_size or more means that the output was truncated
See also
orp_protocol()

◆ orp_input_sendNumeric()

int8_t orp_input_sendNumeric ( char *  keyString,
char *  valueString 
)

Register a numeric input in Octave Remote.

Parameters
keyStringNull terminated string that contains the remote path
Returns
A value of orpProtocol_txBuffer_size or more means that the output was truncated
See also
orp_protocol()