Gateway#

API and Callbacks for the Gateway Component.

Software that supports a CLI based application running on a gateway-style device that has a POSIX compatible operating system. This plugin is NOT compatible with an system-on-a-chip (SOC) platform.

API#

EmberStatus
backchannelStartServer(uint8_t port)
EmberStatus
backchannelStopServer(uint8_t port)
EmberStatus
backchannelReceive(uint8_t port, char *data)
EmberStatus
backchannelSend(uint8_t port, uint8_t *data, uint8_t length)
EmberStatus
backchannelClientConnectionCleanup(uint8_t port)
BackchannelState
backchannelCheckConnection(uint8_t port, bool waitForConnection)
EmberStatus
backchannelCloseConnection(uint8_t port)
EmberStatus
backchannelServerPrintf(const char *formatString,...)
EmberStatus
backchannelClientPrintf(uint8_t port, const char *formatString,...)
EmberStatus
backchannelClientVprintf(uint8_t port, const char *formatString, va_list ap)

Enumerations#

enum
BackchannelStateEnum {
NO_CONNECTION = 0
CONNECTION_EXISTS = 1
NEW_CONNECTION = 2
CONNECTION_ERROR = 3
}

Typedefs#

typedef uint8_t
BackchannelState

API Documentation#

backchannelSupported#

const bool backchannelSupported

Definition at line 52 of file app/framework/plugin-host/gateway/gateway-support.h

backchannelEnable#

bool backchannelEnable

Definition at line 53 of file app/framework/plugin-host/gateway/gateway-support.h

backchannelSerialPortOffset#

int backchannelSerialPortOffset

Definition at line 54 of file app/framework/plugin-host/gateway/gateway-support.h

gatewayBackchannelStop#

void gatewayBackchannelStop (void )
Parameters
N/A

Definition at line 56 of file app/framework/plugin-host/gateway/gateway-support.h

backchannelStartServer#

EmberStatus backchannelStartServer (uint8_t port)
Parameters
N/Aport

Definition at line 58 of file app/framework/plugin-host/gateway/gateway-support.h

backchannelStopServer#

EmberStatus backchannelStopServer (uint8_t port)
Parameters
N/Aport

Definition at line 59 of file app/framework/plugin-host/gateway/gateway-support.h

backchannelReceive#

EmberStatus backchannelReceive (uint8_t port, char * data)
Parameters
N/Aport
N/Adata

Definition at line 60 of file app/framework/plugin-host/gateway/gateway-support.h

backchannelSend#

EmberStatus backchannelSend (uint8_t port, uint8_t * data, uint8_t length)
Parameters
N/Aport
N/Adata
N/Alength

Definition at line 61 of file app/framework/plugin-host/gateway/gateway-support.h

backchannelClientConnectionCleanup#

EmberStatus backchannelClientConnectionCleanup (uint8_t port)
Parameters
N/Aport

Definition at line 63 of file app/framework/plugin-host/gateway/gateway-support.h

backchannelCheckConnection#

BackchannelState backchannelCheckConnection (uint8_t port, bool waitForConnection)
Parameters
N/Aport
N/AwaitForConnection

Definition at line 65 of file app/framework/plugin-host/gateway/gateway-support.h

backchannelMapStandardInputOutputToRemoteConnection#

EmberStatus backchannelMapStandardInputOutputToRemoteConnection (int port)
Parameters
N/Aport

Definition at line 68 of file app/framework/plugin-host/gateway/gateway-support.h

backchannelCloseConnection#

EmberStatus backchannelCloseConnection (uint8_t port)
Parameters
N/Aport

Definition at line 69 of file app/framework/plugin-host/gateway/gateway-support.h

backchannelServerPrintf#

EmberStatus backchannelServerPrintf (const char * formatString, ... )
Parameters
N/AformatString
N/A

Definition at line 70 of file app/framework/plugin-host/gateway/gateway-support.h

backchannelClientPrintf#

EmberStatus backchannelClientPrintf (uint8_t port, const char * formatString, ... )
Parameters
N/Aport
N/AformatString
N/A

Definition at line 71 of file app/framework/plugin-host/gateway/gateway-support.h

backchannelClientVprintf#

EmberStatus backchannelClientVprintf (uint8_t port, const char * formatString, va_list ap)
Parameters
N/Aport
N/AformatString
N/Aap

Definition at line 72 of file app/framework/plugin-host/gateway/gateway-support.h

Enumeration Documentation#

BackchannelStateEnum#

BackchannelStateEnum
Enumerator
NO_CONNECTION
CONNECTION_EXISTS
NEW_CONNECTION
CONNECTION_ERROR

Definition at line 36 of file app/framework/plugin-host/gateway/gateway-support.h

Typedef Documentation#

BackchannelState#

typedef uint8_t BackchannelState

Definition at line 34 of file app/framework/plugin-host/gateway/gateway-support.h