Contents

Additional Library Functions



The additional functions of the RemoteXY library allow you to manage operating modes and obtain the current connection states.

Check app connection

uint8_t RemoteXYEngine.appConnected()

Returns the connection status of the mobile application. It allows you to determine whether the phone is currently connected to the board.

  • Result is 0 — the app is not connected;
  • Result is 1 — the app is connected.

If multiple graphical interfaces are used, the result will be 1 if the app is connected to any of them. To check the connection status for a specific graphical interface, use the corresponding function of that interface:

gui->appConnected ();

Network Connection Check

uint8_t RemoteXYEngine.netsConfigured()

Returns the network connection status

  • Result is 0 - network is not connected;
  • Result is 1 - network is connected.

Use this function to get the current network connection status for different network interfaces:

  • WiFi - the module has successfully connected to a WiFi network using login and password.
  • WiFi Access Point - the access point has been created.
  • Ethernet - the Ethernet module is registered on the network and has received an IP address.

If multiple network connections are used simultaneously, the function will return 1 only if all network connections have been successfully configured. To check the connection status for a specific network interface, use the similar method of that interface: net->configured().

GUI Connection Readiness Check

uint8_t RemoteXYEngine.connectionsConfigured()

Returns the status of the graphical interface readiness for connection.

  • Result is 0 - not ready for connection
  • Result is 1 - ready for connection

The readiness for connection is evaluated differently depending on the communication method. The function returns 1 only if the graphical interface is fully ready to accept connections:

  • Cloud server - the network is configured and the connection to the cloud server is established.
  • Ethernet - there is a network connection and the server is open on the specified port.
  • WiFi Access Point - the access point has been created and the server is open on the specified port.
  • Bluetooth - the Bluetooth module is configured and ready to accept clients.

If multiple graphical interfaces are used simultaneously, the function returns 1 only when all of them are ready. To check the readiness of a specific graphical interface, use the similar method of that interface: gui->connectionsConfigured ().