8. SmartConsole Android and iOS Application
8.1. Overview
The SmartConsole reference application comes with a CodeLess demo application for Android. The SmartConsole application can discover, connect, and exchange AT commands or data with CodeLess enabled devices within the Bluetooth RF range of the mobile device.
Feature List:
Device discovery
Connection to a discovered device
Command mode
Binary mode
Figure 45 SmartConsole Application - iOS and Android
8.2. Installation
8.2.1. Android Application
The Android application can be found in Google Play Store and easily installed from there as any other Android application. To find the application, a user can search for “Dialog SmartConsole”. Then the user should open the application’s description and press the ‘Install’ button. During the installation, permission to access device resources will be requested as shown in Figure 46. The permission should be granted. After installation is complete, the application can be open either using the “Open” button in the Play Store or from the Android application drawer.
Figure 46 SmartConsole on Play Store
Figure 47 Installing the SmartConsole Application
8.2.2. iOS Application
The iOS application can be found in Apple App Store and easily installed from there as any other iOS application. To find the application, a user can search for “SmartConsole” or “Dialog SmartConsole”. Then the user has to open the applications description and press the cloud button to download and install it. After installation is complete, the application can be opened either using the “Open” button in the App Store or from the iOS desktop.
8.3. Device List
The SmartConsole Android application can discover and connect to CodeLess devices. When the application starts, the scan screen is displayed, showing the CodeLess devices in range. Device name, BD Address, RSSI, and advertised services are displayed in the list of discovered devices. By pressing the filter button (top right corner), the user can open the Scan Filter screen, to add and apply any scan filter in terms of Signal, Services, Beacon/Device name, address, and advertising data.
If the desired CodeLess device is not found, the scan process can be reinitiated by clicking SCAN control at the top of the screen. The user can connect to any of the retrieved BLE CodeLess enabled devices by clicking the corresponding item of the list. During connection establishment, the “Connecting, please wait…” screen message will appear. Upon successful connection, the AT Console screen will be shown. Otherwise, the application will return to the Scan screen, showing an indication “Device disconnected”.
Figure 48 Scan and Scan Filter Screens
Figure 49 Connection Screen
8.4. Navigation Drawer Functionality
The SmartConsole mobile application adopts the two distinct operation modes of CodeLess Software, supporting Command mode and Binary mode.
8.4.1. Command Mode
While the CodeLess device operates in Command Mode, the user can interact with the CodeLess device using any of the available AT commands. Using the navigation drawer, SmartConsole provides the user with many options to execute AT commands, without the necessity to write the actual command, but by just changing the desired parameters.
The tabs and their functionality will be described separately in the following sections: - AT Console - System - Bluetooth - Peripherals - Events - Data
Figure 50 Command Mode Screen
8.4.2. AT Console
SmartConsole application is not a CodeLess enabled device, so all AT commands are sent to the remote CodeLess device through the “Enter command” prompt. In general, remote commands include “r” indication after AT.
For example, ATrI is a device information query for the remote CodeLess device or ATr+GAPSTATUS reports the Bluetooth role and the connection status of the remote CodeLess device.
The “r” indication is added by default from SmartConsole in every AT command, regardless if the user included it while typing the command.
In the top frame, the user can see a console with all executed commands and their reply messages. In the bottom frame, the user can:
Add AT+ prefix to the command prompt, by pressing button 1
Figure 51 AT Console Screen
Clear the console of the upper frame, by pressing button 2
Figure 52 Clear Console Screen
- Bookmark the command that is currently shown in the command prompt by pressing button 3.
Bookmarks are unique, if command is already bookmarked, the command is not added again in the list. Any of the bookmarks can be deleted or rearranged
Figure 53 Edit Bookmarks
Navigate downwards through command history by pressing button 4 Figure 51
Navigate upwards through command history by pressing button 5 Figure 51
Write test scripts by pressing button 6 Figure 51. An example of a test script is depicted in the first image as shown below.
The user can clear the test scripts, by pressing 1 Figure 51, save the current script using 2 Figure 51, and open an existing script located on the mobile phone using 3. Execution can start by pressing the START button and stop if an error response is received, in case this option is selected. The CANCEL button aborts the whole process of writing a test scripts and doesn’t save any change.
Figure 54 Create Test Scenarios and Scripts
See the bookmark list and select any of the bookmarked command to run by pressing button 7 Figure 51
Figure 55 Bookmark List
See the list of all executed AT commands by pressing button 8 Figure 51
Figure 56 Command History
8.4.3. System
On the System tab, the user can read basic information, be informed about the current operating mode of the connected CodeLess device, but can also trigger a platform reset.
The SmartConfig application retrieves information from the remote CodeLess device such as its firmware version, hardware type, BD address, SDK version, battery capacity in the percentage of full capacity and RSSI level. Any time this information can be refreshed by pressing the refresh icon at the top right side of the application.
Changing the operating mode can be done easily either by pressing 2 Figure 51 or by pressing the AT+BINREQ button.
Figure 57 System Screen
8.4.4. Bluetooth
The Bluetooth tab manages connection parameters, the maximum MTU size, advertising, and scan response data. Acquisition of the currently applied values is done by reading the corresponding characteristics, while updating any of the values is done by writing the corresponding characteristics.
For further details on the allowed values of each command, a user can refer to AT+CONPAR, AT+MAXMUT, AT+ADVDATA and AT+ADVRESP from Chapter 9.
Figure 58 Bluetooth Screen
8.4.5. Peripherals
The Remote management of any specified IO pin or any peripheral that is connected to the CodeLess device can be done using the Peripherals tab.
In the GPIO section, a list of all pin configurations is provided. The user can set the functionality of any IO pin, change it by pressing the write characteristic button, and afterward set its output.
The Read button lists all pin configurations and the Reset button sets IO configuration to default.
The AT commands that are used to support this functionality are AT+IOCFG, AT+IO, and ATZ and can be found in Chapter 9.
In the I2C section, SCL and SDA pins both with the I2C configuration can be set. AT+I2CCFG and AT+IOCFG are used to support this functionality.
Figure 59 Peripherals Screen (GPIO and I2C)
In the SPI section (Figure 18), CS, CLK, MOSI, and MISO pins with the SPI configuration can be set. AT+SPICFG and AT+IOCFG are used to support this functionality.
Figure 60 Peripherals Screen (SPI and Misc)
In Misc, UART’s Baud rate and Echo mode can be configured with a heartbeat signal indicating that the device is working. AT+BAUD, ATE and AT+HRTBT are used (Refer to Chapter 9).
8.4.6. Events
The Events tab can be used to activate or deactivate the predefined events, execute handlers attached to any of the predefined events, add commands to any available slot and set timers to create simple scenarios. Buttons 1 and 2 shown in Figure 61, are used to start and stop the timer at the selected slot. The AT commands that are used to support this functionality are AT+CMD, AT+TMRSTART, AT+TMRSTOP, AT+EVENT, and AT+HNDL.
Figure 61 Events Screen
8.4.7. Data
The Data tab can be used to print a specified string to the UART of the connected CodeLess device without the need to enter Binary mode. The user can store any string to a selected memory location and can generate random numbers. The AT commands that are used in this section are AT+PRINT, AT+MEM, and AT+RANDOM.
Figure 62 Data Screen
8.4.7.1. Binary Mode
The CodeLess device can change its current operating mode from command to binary just by pressing button 1. Upon connection, the CodeLess device enters Binary mode and a side menu environment is shown to the user, providing the functionality of the application. After connection the user may navigate to three operating mode screens that will be explained in the following paragraphs.
Figure 63 Binary Mode Screen
8.4.8. Console Mode
The Console mode is a serial port console emulation mode. Any character typed on the keyboard is immediately sent to the peer device and any character received is displayed in the reception display box.
Figure 64 Console Mode Screen
8.4.9. Read/Transfer Mode
The Read/Transfer mode allows the user to send data to and receive data from the peer device. Initially, the reception display box is shown, where received data can be displayed in ASCII or HEX format. Also, the user can clear the received data, enable or disable the incoming flow by pressing the Start or Stop button respectively.
For the TX part, a text box is shown where data can be entered via the keyboard or pasted by long pressing the field and selecting Paste. Pressing the Send button will send the displayed data once or repeatedly (depending on the state of the “cyclic sending” toggle switch) with the chosen interval.
Figure 65 Read/Transfer Data Screen
8.4.10. Data File Streaming Mode
The user can also send a file instead of individual strings of characters. This function can be accessed in the Data File Streaming screen, where the user can browse the device’s file system to find the file to be transmitted. The transmitted file can be cut into chunks which are sent with specific intervals.
Figure 66 Data File Streaming Screen
8.5. Information and Disclaimer Screens
The Information screen displays contact information and the version of the application as shown below. The Disclaimer screen contains the disclaimer notes.
Figure 67 Information and Disclaimer Screen
8.6. Enter/Exit CodeLess Binary mode using Generic GATT Client
When developing a custom mobile application for transferring data to Codeless peripheral in Binary mode. To enter this mode user needs to implement a sequence of GATT commands between the mobile application and the Codeless peripheral. The sequence of commands shown in below table needs to be followed from start to finish.
# |
Action |
Direction |
Value |
UUID |
Comment |
|---|---|---|---|---|---|
1 |
Write Request |
From Mobile application to |
0x01 |
0x e2048b39-d4f9-4a45-9f25-1856c10d5639 |
Enable the CodeLess Flow Control notification. The +COMMAND MODE SUPPORTED string will be printed to the console of the CodeLess |
2 |
Write Request |
From Mobile application to |
0x01 |
0x 0783b03e-8535-b5a0-7140-a304d2495cb8 |
Enable the DSPS Server Tx notification.The +BINARY MODE SUPPORTED string will be printed to the console of the CodeLess peripheral |
3 |
Write Request |
From Mobile application to |
0x01 |
0x 0783b03e-8535-b5a0-7140-a304d2495cb9 |
Enable the DSPS Flow Control notification |
4 |
Write Command |
From Mobile application to |
0x01 |
0x 0783b03e-8535-b5a0-7140-a304d2495cb9 |
Write value 0x01 to the DSPS Flow Control Characteristic |
5 |
Write Request |
From Mobile application to |
0x 41 54 2b 42 49 4e 52 45 51 00 |
0x 914f8fb9-e8cd-411d-b7d1-14594de45425 |
Write the CodeLess Inbound Command characteristic with the AT+BINREQ command sent from the mobile phone to the CodeLess Peripheral.The |
6 |
Read Request |
From Mobile application to |
N/A |
0x 3bb535aa-50b2-4fbe-aa09-6b06dc59a404 |
Read the CodeLess Outbound Command characteristic. An OK (0x 0d 0a 4f 4b 0d 0a) is expected in the Read Response. This must be read otherwise |
7 |
Enter the AT+BINREQACK |
From CodeLess peripheral to |
N/A |
0x e2048b39-d4f9-4a45-9f25-1856c10d5639 |
A notification will be sent to the mobile phone application informing it that new data has been written to the CodeLess Outbound Command |
8 |
Read Request |
From Mobile application to |
N/A |
0x 3bb535aa-50b2-4fbe-aa09-6b06dc59a404 |
Read the CodeLess Outbound Command characteristic.The AT+BINREQACK string (0x 41 54 2b 42 49 4e 52 45 51 41 43 4b) is sent from the CodeLess |
9 |
Write Request |
From Mobile application to |
0x 0d 0a 4f 4b 0d 0a 00 |
0x 914f8fb9-e8cd-411d-b7d1-14594de45425 |
Write the CodeLess Inbound Command characteristic to acknowledge the AT+BINREQACK string. It is expected that an OK will be printed to the CodeLess |
After completing all the mentioned steps successfully the CodeLess peripheral will now be set in Binary mode. In binary mode the data can be sent and received between the mobile application and the CodeLess peripheral. See the below table to implement data transfer.
Direction |
Service Name |
UUID |
Method |
Comment |
|---|---|---|---|---|
From Mobile Application to |
DSPS Server RX |
0x 0783b03e-8535b5a0-7140a304-d2495cba |
Write No Response |
Data will be forwarded to the |
From Codeless Peripheral to |
DSPS Server TX |
0x 0783b03e-8535b5a0-7140a304-d2495cb8 |
Notify |
- |
Similarly, to exit the binary mode a sequence of GATT commands needs to be followed. The below table shows how to exit the binary mode:
# |
Action |
Direction |
Value |
UUID |
Comment |
|---|---|---|---|---|---|
1 |
Write Request |
From Mobile application to |
0x01 |
0x e2048b39-d4f9-4a45-9f25-1856c10d5639 |
Enable the CodeLess Flow Control notification. The +COMMAND MODE SUPPORTED string will be printed to the console of the CodeLess |
2 |
Write Request |
From Mobile application to |
0x01 |
0x 0783b03e-8535-b5a0-7140-a304d2495cb8 |
Enable the DSPS Server Tx notification.The +BINARY MODE SUPPORTED string will be printed to the console of the CodeLess peripheral |
3 |
Write Request |
From Mobile application to |
0x01 |
0x 0783b03e-8535-b5a0-7140-a304d2495cb9 |
Enable the DSPS Flow Control notification |
4 |
Write Command |
From Mobile application to |
0x01 |
0x 0783b03e-8535-b5a0-7140-a304d2495cb9 |
Write value 0x01 to the DSPS Flow Control Characteristic |
5 |
Write Request |
From Mobile application to |
0x 41 54 2b 42 49 4e 52 45 51 45 58 49 54 00 |
0x 914f8fb9-e8cd-411d-b7d1-14594de45425 |
Write the CodeLess Inbound Command characteristic with the AT+BINREQEXIT command sent from the mobile phone to the CodeLess Peripheral.The |
6 |
Read Request |
From Mobile application to |
N/A |
0x 3bb535aa-50b2-4fbe-aa09-6b06dc59a404 |
Read the CodeLess Outbound Command characteristic. An OK (0x 0d 0a 4f 4b 0d 0a) is expected in the Read Response. This must be read otherwise |
7 |
Enter the AT+BINREQEXITACK |
From CodeLess peripheral to |
0x 41 54 2b 42 49 4e 52 45 51 45 58 49 54 41 43 4b 00 |
0x 914f8fb9-e8cd-411d-b7d1-14594de45425 |
A notification will be sent to the mobile phone application informing it that new data has been written to the CodeLess Outbound Command |
8 |
Read Request |
From Mobile application to |
N/A |
0x 3bb535aa-50b2-4fbe-aa09-6b06dc59a404 |
Read the CodeLess Outbound Command characteristic.The AT+BINREQEXITACK string (0x 41 54 2b 42 49 4e 52 45 51 41 43 4b 00) is sent from the CodeLess |
9 |
Write Request |
From Mobile application to |
0x 0d 0a 4f 4b 0d 0a 00 |
0x 914f8fb9-e8cd-411d-b7d1-14594de45425 |
Write the CodeLess Inbound Command characteristic to acknowledge the AT+BINREQEXITACK string. It is expected that an OK will be printed to the CodeLess |
The procedures mentioned in this section can be tested using the Renesas Smartbond application which is a Generic GATT Client application. For more information user can refer to the source code of SmartConsole application which is an application specifically for CodeLess.