RCKit
Public Member Functions | List of all members
ESP8266Transceiver Class Reference

Defines a WiSHield RCOIP Transceiver. More...

#include <ESP8266Transceiver.h>

Inheritance diagram for ESP8266Transceiver:
Inheritance graph
[legend]
Collaboration diagram for ESP8266Transceiver:
Collaboration graph
[legend]

Public Member Functions

 ESP8266Transceiver ()
 
virtual void init ()
 
virtual void run ()
 
virtual void sendReply (uint8_t *msg, uint16_t len)
 
- Public Member Functions inherited from Transceiver
virtual void setDelegate (RCRx *delegate)
 
virtual void receivedRequest (uint8_t *msg, uint16_t len, uint16_t rssi=0)
 

Additional Inherited Members

- Protected Attributes inherited from Transceiver
RCRx_delegate
 Object whose handleRequest() function will be called whenever an RCOIP message is received.
 

Detailed Description

Defines a WiSHield RCOIP Transceiver.

This is one of several types of Transceiver that RCRx can use to communicate with an RCOIP transmitter. It works with the WiFi device on an ESP8266 based device

The default WiFi configuration is:

There is only permitted to be one instance of ESP8266Transceiver. This is because of the low level C code that glues the WiShield code to ESP8266Transceiver, and the fact there can also be only one instance of the WiShield object.

Constructor & Destructor Documentation

◆ ESP8266Transceiver()

ESP8266Transceiver::ESP8266Transceiver ( )

Constructor. Creates a new ESP8266Transceiver object.

Member Function Documentation

◆ init()

virtual void ESP8266Transceiver::init ( )
virtual

Initialise the WiShield using the WiFi configuration in ESP8266Transceiver.cpp Call this once before using the Transceiver

Reimplemented from Transceiver.

◆ run()

virtual void ESP8266Transceiver::run ( )
virtual

Poll the object for activity. This is expected to be called frequently in the main loop. It processes the WiFi stack, checking for received messages. During processing, and RCOIP message received by the preconfigured port and address will be given to the RCRx object pointed to by _delegate

Reimplemented from Transceiver.

◆ sendReply()

virtual void ESP8266Transceiver::sendReply ( uint8_t *  msg,
uint16_t  len 
)
virtual

Send an RCOIP reply message to the sender of the current received message.

Parameters
[in]msgPointer to the RCOP message.
[in]lenLength of the RCOIP message in bytes.

Reimplemented from Transceiver.


The documentation for this class was generated from the following file: