MySensors Library & Examples  2.3.2-38-gaa76d26
MyGatewayTransport.h
Go to the documentation of this file.
1 /*
2  * The MySensors Arduino library handles the wireless radio link and protocol
3  * between your home built sensors/actuators and HA controller of choice.
4  * The sensors forms a self healing radio network with optional repeaters. Each
5  * repeater and gateway builds a routing tables in EEPROM which keeps track of the
6  * network topology allowing messages to be routed to nodes.
7  *
8  * Created by Tomas Hozza <[email protected]>
9  * Copyright (C) 2015 Tomas Hozza
10  * Full contributor list: https://github.com/mysensors/MySensors/graphs/contributors
11  *
12  * Documentation: http://www.mysensors.org
13  * Support Forum: http://forum.mysensors.org
14  *
15  * This program is free software; you can redistribute it and/or
16  * modify it under the terms of the GNU General Public License
17  * version 2 as published by the Free Software Foundation.
18  */
19 
74 #ifndef MyGatewayTransport_h
75 #define MyGatewayTransport_h
76 
77 #include "MyProtocol.h"
78 #include "MySensorsCore.h"
79 
80 #define MSG_GW_STARTUP_COMPLETE "Gateway startup complete."
81 
82 #if defined(MY_DEBUG_VERBOSE_GATEWAY)
83 #define GATEWAY_DEBUG(x,...) DEBUG_OUTPUT(x, ##__VA_ARGS__)
84 #else
85 #define GATEWAY_DEBUG(x,...)
86 #endif
87 
91 void gatewayTransportProcess(void);
92 
97 bool gatewayTransportInit(void);
98 
104 bool gatewayTransportSend(MyMessage &message);
105 
110 bool gatewayTransportAvailable(void);
111 
117 
118 #endif /* MyGatewayTransportEthernet_h */
119 
gatewayTransportReceive
MyMessage & gatewayTransportReceive(void)
Pick up last message received from controller.
gatewayTransportInit
bool gatewayTransportInit(void)
Initialize gateway transport driver.
MySensorsCore.h
gatewayTransportProcess
void gatewayTransportProcess(void)
Process gateway-related messages.
gatewayTransportAvailable
bool gatewayTransportAvailable(void)
Check if a new message is available from controller.
gatewayTransportSend
bool gatewayTransportSend(MyMessage &message)
Send message to controller.
MyMessage
MyMessage is used to create, manipulate, send and read MySensors messages.
Definition: MyMessage.h:289