Invok Controller library is a wrapper library based on:
This library is used for connecting development boards to the Controller app. Controller App is now available on Google Play.
We have added the following:
- Example sketch for motion control.
We have made the following changes:
- Option to turn on/off Debug message. Debug message begins with [DEBUG] identifier.
- Remove unused function from previous release.
- Add ability to stop/remove mDNS service when device is connected.
- Add connection status watcher by polling PING message from client.
This library is still a work in progress. There may be some breaking changes in the future, which might require you to replace, re-organize, and rearrange functions or variables included in this library. Use this library at your own risk.
- ESP32 Development Board Family (WiFi)
- ESP8266 Development Board Family (WiFi)
- WiFiManager, this awesome library lets you connect you ESP board to WiFi without harcoding the SSID and password.
- Setting ESPs as Websocket Server
- WebSocket PING/PONG heartbeat routine
- Receive control data from Controller app
- Download the Controller app from Google Play Store.
- Install the following library:
- Download/clone this repository, and put it into libraries folder of Arduino directory. Ensure you have downloaded the latest version.
- Compile and upload example sketch.
- With WiFiManager, you can now setup WiFi without hardcoding SSID and password. After uploading the firmware, connect to ESP Wifi, SSID should be something like ESP_XXXX.
- You will then be directed to configuration portal, if you are not redirected automatically, access the portal with this address (1.1.1.1). Internal LED will turn on when in wifi configuration mode.
- Choose SSID you want to connect to, and input the password.
- When connected to network, program will print IP Address on Serial Monitor, take note of this address.
- In Controller app home page, tap Wi-Fi icon on top right corner, this will route you to connection setup page.
- Input the IP Address printed on serial monitor to address field.
- Press Connect.
- Status icon on top right corner will turn green when connection is established.
- Test connection by sending message. Server will respond or echo back the same message.
Create a new arduino sketch, and include InvokController.h
#include <InvokController.h>
Instantiate Controller object as global variable before setup(), and specify controller type, port, and debug mode as argument.
Controller myController("websocket", 80, false);
In setup(), initiate serial data transmission,
Serial.begin(115200);
set hostname of your device for mDNS identification,
myController.setHostname("myDevice")
and continue to call begin method of controller.
myController.begin();As soon as you call begin() method, Controller will start a Wi-Fi configuration portal. You can then enter/select your Wi-Fi. If connection is succesfull, the ESP board will start to broadcast a service through mDNS protocol. The controller app will find your ESP device automatically, and you can connect to it without having to check the serial monitor.
Inside loop(), do not forget to call,
myController.loop();
delay() function use is discouraged, because it blocks the program routine. It might cause the websocket connection to drop. Use millis() instead, and create if statement to execute routine every certain time period.
Sample sketch are provided to demo the functionality of the App.
In Controller app, Joystick movement will generate 5 data, [x, y, r, theta, intensity].
- x,y represent coordinate of the pad in cartesian form.
- r,theta represent coordiate of the pad in polar form, where theta range is [0 - 360°].
- intensity is the relative distance of pad from center circle to outer circle in percentage out of 100.
ControllerName.joystick.getX() -> Return x coordinate as double.
ControllerName.joystick.getY() -> Return y coordinate as double.
ControllerName.joystick.getR() -> Return range value as double.
ControllerName.joystick.getTheta() -> Return angle as double.
ControllerName.joystick.getIntensity() -> Return intensity as double.
ControllerName.joystick.getButtonState() -> Return button state as bool.
All of these datas are sent to the server via WiFi on selected protocol, parsed, and ready to be used.
There is a small deadzone in the middle of joystick to prevent unwanted control motion.
Pick any color on color wheel. There are two modes available:
- Update -> when pressed, app will send color info to the board.
- Continuous -> triggered by long-press the update button, will continously send color data as user pick colors
ControllerName.colorPicker.getR() -> Return Red component of RGB color space as int.
ControllerName.colorPicker.getG() -> Return Green component of RGB color space as int.
ControllerName.colorPicker.getB() -> Return Blue component of RGB color space as int.
ControllerName.colorPicker.getH() -> Return Hue component of HSV color space as double.
ControllerName.colorPicker.getS() -> Return Saturation component of HSV color space as double.
ControllerName.colorPicker.getV() -> Return Value component of HSV color space as double.
Set state of button individually or all button at once. App will send 12 button states as string. The data will then be parsed and processed, and then user can get state of each button pressed in boolean.
ControllerName.buttonArray.getButtonArrayState(int button) -> Return button state as bool.
User need to specify which button state to get by passing number 0-11 (correspond to button 1 - 12) as parameter to getter function.
Set state of slider individually or all sliders at once with master slider. App will send 6 slider value as string. The data will then be parsed and processed, and then user can get value of each slider in double with single precision (xx.x).
ControllerName.slider.getSliderData(int slider) -> Return slider value as double.
User need to specify which slider to get by passing number 0-5 (correspond to slider 1 - 6) as parameter to getter function.
Controller serial monitor act just like Arduino serial monitor. It can send, receive and print data between ESP device and Controller app.
ControllerName.print(std::string stringToPrint) -> will print 'stringToPrint' in Controller app.
ControllerName.getIncomingCommand() -> Return a std::string received from Controller app.
ControllerName.setIncomingCommand(std::string command) -> Setter function to set the command when it is received from the app. This setter can also be used to flush the buffer by passing empty string as parameter ("").
In Controller app, Motion Control will generate 5 data, [x, y, r, theta, intensity]. This control method is very similar to Joystick. In motion control, the pointer move according to the absolute orientation of the phone.
- x,y represent coordinate of the pointer in cartesian form.
- r,theta represent coordiate of the pointer in polar form, where theta range is [0 - 360°].
- intensity is the relative distance of pad from center circle to outer circle in percentage out of 100.
ControllerName.motion.getX() -> Return x coordinate as double.
ControllerName.motion.getY() -> Return y coordinate as double.
ControllerName.motion.getR() -> Return range value as double.
ControllerName.motion.getTheta() -> Return angle as double.
ControllerName.motion.getIntensity() -> Return intensity as double.
All of these datas are sent to the server via WiFi on selected protocol, parsed, and ready to be used.
There is a small deadzone in the middle of the Pad to prevent unwanted control motion.