Detailed Description

It looks like Bluetooth modules arrive in all kinds of initial configuration. Sometimes we need to execute a one-time initialization including settings the baud rate. rusEFI setting uartConsoleSerialSpeed or tunerStudioSerialSpeed has to match BT module configuration.

Author: andreika, (c) 2017

Definition in file bluetooth.cpp.

Functions
static void	btWrite (TsChannelBase tsChannel, const char str)

static int	btReadLine (TsChannelBase tsChannel, char str, size_t max_len)

static int	btWaitOk (SerialTsChannelBase *tsChannel)

static int	btBaudOk (SerialTsChannelBase *tsChannel)

static void	runCommands (SerialTsChannelBase *tsChannel)

uint8_t	findBaudIndex (SerialTsChannelBase *tsChannel)

void	bluetoothStart (bluetooth_module_e moduleType, const char baudRate, const char name, const char *pinCode)

void	bluetoothSoftwareDisconnectNotify (SerialTsChannelBase *tsChannel)

Variables
static volatile bool	btSetupIsRequested = false

bluetooth_module_e	btModuleType

static int	setBaudIdx = -1

static char	btName [20+1]

static char	btPinCode [4+1]

static uint8_t	workingBaudIndex

struct {

uint32_t rate

uint8_t code

}	baudRates []

static const int	btModuleTimeout = TIME_MS2I(2500)

Function Documentation

◆ bluetoothSoftwareDisconnectNotify()

void bluetoothSoftwareDisconnectNotify ( SerialTsChannelBase * tsChannel )

Called by runBinaryProtocolLoop() if a connection disconnect is detected. Bluetooth init code needs to make sure that there's no interference of the BT module and USB-UART (connected to PC)

Definition at line 338 of file bluetooth.cpp.

                                                                       {
    if (btSetupIsRequested) {
        efiPrintf("*** Bluetooth module setup procedure ***");
 
        /* JDY33 & JDY31 supports disconnect on request */
        if ((btModuleType != BLUETOOTH_JDY_3x) &&
            (btModuleType != BLUETOOTH_JDY_31)) {
            efiPrintf("!Warning! Please make sure you're not currently using the BT module for communication (not paired)!");
            efiPrintf("TO START THE PROCEDURE: PLEASE DISCONNECT YOUR PC COM-PORT FROM THE BOARD NOW!");
            efiPrintf("After that please don't turn off the board power and wait for ~15 seconds to complete. Then reconnect to the board!");
        }
 
        uint8_t tmp[1];
        if (tsChannel->readTimeout(tmp, 1, BLUETOOTH_SILENT_TIMEOUT) != 0) {
            efiPrintf("The Bluetooth module init procedure is cancelled (wait for silent timeout)!");
            btSetupIsRequested = false;
            return;
        }
 
        runCommands(tsChannel);
        btSetupIsRequested = false;
    }
}

Referenced by tsProcessOne().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ bluetoothStart()

void bluetoothStart	(	bluetooth_module_e	moduleType,
		const char *	baudRate,
		const char *	name,
		const char *	pinCode
	)

Start Bluetooth module initialization using UART connection:

wait for PC communication disconnect;
reconfigure the UART;
send AT-commands to the module;
restore connection to PC.

Definition at line 275 of file bluetooth.cpp.

                                                                                                                {
    static const char *usage = "Usage: bluetooth_<hc05/hc06/bk/jdy> <baud> <name> <pincode>";
 
    if ((baudRate == nullptr) || (name == nullptr) || (pinCode == nullptr)) {
        efiPrintf("%s", usage);
        return;
    }
 
    if (getBluetoothChannel() == nullptr) {
        efiPrintf("This firmware does not support bluetooth [%s]", getTsSignature());
        return;
    }
 
    if (btSetupIsRequested) {
        efiPrintf("The Bluetooth module init procedure is already started!");
        return;
    }
 
    // now check the arguments and add other commands:
    // 1) baud rate
    int baud = atoi(baudRate);
    // find a known baud rate in our list
    setBaudIdx = -1;
    for (size_t i = 0; i < efi::size(baudRates); i++) {
        if ((int)baudRates[i].rate == baud) {
            setBaudIdx = i;
            break;
        }
    }
    // check the baud rate index
    if (setBaudIdx < 0) {
        // unknown baud rate
        efiPrintf("Wrong <baud> parameter '%s'! %s", baudRate, usage);
        return;
    }
 
    // 2) check name
    if ((strlen(name) < 1) || (strlen(name) > 20)) {
        efiPrintf("Wrong <name> parameter! Up to 20 characters expected! %s", usage);
        return;
    }
 
    // 3) check pin code
    if (strlen(pinCode) != 4) {
        efiPrintf("Wrong <pincode> parameter! 4 digits expected! %s", usage);
        return;
    }
    for (int i = 0; i < 4; i++) {
        if (!isdigit(pinCode[i])) {
            efiPrintf("<pincode> should contain digits only %s", usage);
            return;
        }
    }
 
    /* copy settings */
    strncpy(btName, name, 20);
    strncpy(btPinCode, pinCode, 4);
 
    btModuleType = moduleType;
    btSetupIsRequested = true;
}

Referenced by startTunerStudioConnectivity().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ btBaudOk()

static int btBaudOk ( SerialTsChannelBase * tsChannel )

static

Definition at line 108 of file bluetooth.cpp.

{
    int len;
    int ret = -1;
    char tmp[16];
 
    /* wait for resposne  */
    len = btReadLine(tsChannel, tmp, sizeof(tmp));
    if (len == 9) {
            ret = 0;
    }
 
    return ret;
}

Referenced by findBaudIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ btReadLine()

static int btReadLine	(	TsChannelBase *	tsChannel,
		char *	str,
		size_t	max_len
	)

static

Definition at line 63 of file bluetooth.cpp.

                                                                           {
    size_t len = 0;
 
    /* read until end of line */
    do {
        if (len >= max_len) {
            efiPrintf("BT reply is unexpectedly long");
            return -1;
        }
        if (tsChannel->readTimeout((uint8_t *)&str[len], 1, btModuleTimeout) != 1) {
            efiPrintf("Timeout waiting for BT reply after %d byte(s)", len);
            return -1;
        }
    } while (str[len++] != '\n');
 
    /* termination */
    if (len < max_len)
        str[len] = 0;
    else
        str[max_len - 1] = 0;
 
#if EFI_BLUETOOTH_SETUP_DEBUG
    if (len) {
        efiPrintf("Received %d %s", len, str);
    }
#endif
 
    return len;
}

Referenced by btBaudOk(), btWaitOk(), and runCommands().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ btWaitOk()

static int btWaitOk ( SerialTsChannelBase * tsChannel )

static

Definition at line 93 of file bluetooth.cpp.

                                                    {
    int len;
    int ret = -1;
    char tmp[16];
 
    /* wait for '+OK\r\n' */
    len = btReadLine(tsChannel, tmp, sizeof(tmp));
    if (len == 5) {
        if (strncmp(tmp, "+OK", 3) == 0)
            ret = 0;
    }
 
    return ret;
}

Referenced by findBaudIndex(), and runCommands().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ btWrite()

static void btWrite	(	TsChannelBase *	tsChannel,
		const char *	str
	)

static

Definition at line 54 of file bluetooth.cpp.

{
    /* Just a wrapper for debug purposes */
#if EFI_BLUETOOTH_SETUP_DEBUG
    efiPrintf("sending %s", str);
#endif
    tsChannel->write((uint8_t *)str, strlen(str));
}

Referenced by findBaudIndex(), and runCommands().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findBaudIndex()

uint8_t findBaudIndex ( SerialTsChannelBase * tsChannel )

Called during bluetooth initialization. Checks to see if module responds to common baud rates returns the index of the found baud

Definition at line 233 of file bluetooth.cpp.

                                                      {
    // find current baudrate
    for(uint8_t baudIdx=0; baudIdx < efi::size(baudRates); baudIdx++) {
        tsChannel->stop();
        chThdSleepMilliseconds(10); // safety
 
        if (baudIdx == efi::size(baudRates)) {
            efiPrintf("Failed to find current BT module baudrate");
            tsChannel->start(engineConfiguration->tunerStudioSerialSpeed);
            return 255;//failed
        }
 
        efiPrintf("Restarting at %lu", baudRates[baudIdx].rate);
        tsChannel->start(baudRates[baudIdx].rate);
        chThdSleepMilliseconds(10); // safety
 
        /* Ping BT module */
        btWrite(tsChannel, "AT\r\n");
        if (btWaitOk(tsChannel) == 0) {
            return baudIdx;
        } else if (btModuleType == BLUETOOTH_JDY_3x) {
            /* try to disconnect in case device already configured and in silence mode */
            btWrite(tsChannel, "AT+DISC\r\n");
            if (btWaitOk(tsChannel) == 0) {
                efiPrintf("JDY33 disconnected");
                chThdSleepMilliseconds(10); // safety
                return baudIdx;
            }
        } else if (btModuleType == BLUETOOTH_JDY_31) {
            /* try to disconnect in case device already configured and in silence mode */
            btWrite(tsChannel, "AT+BAUD\r\n");
            if (btBaudOk(tsChannel) == 0) {
                efiPrintf("JDY31 disconnected");
                chThdSleepMilliseconds(10); // safety
                return baudIdx;
            }
        }
        /* try next baudrate */
    }
    return 255;//failed
}

Referenced by runCommands().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ runCommands()

static void runCommands ( SerialTsChannelBase * tsChannel )

static

Definition at line 125 of file bluetooth.cpp.

                                                        {
    char tmp[64];
 
    workingBaudIndex = findBaudIndex(tsChannel);//find it
    if(workingBaudIndex == 255)//failed
        return;//problem connecting
 
    if ((btModuleType == BLUETOOTH_JDY_3x) ||
        (btModuleType == BLUETOOTH_JDY_31))  {
#if EFI_BLUETOOTH_SETUP_DEBUG
        /* Debug, get version, current settings */
        btWrite(tsChannel, "AT+VERSION\r\n");
        btReadLine(tsChannel, tmp, sizeof(tmp));
 
        btWrite(tsChannel, "AT+BAUD\r\n");
        btReadLine(tsChannel, tmp, sizeof(tmp));
 
        if (btModuleType == BLUETOOTH_JDY_3x) {
            btWrite(tsChannel, "AT+TYPE\r\n");
            btReadLine(tsChannel, tmp, sizeof(tmp));
        }
 
        btWrite(tsChannel, "AT+PIN\r\n");
        btReadLine(tsChannel, tmp, sizeof(tmp));
 
        btWrite(tsChannel, "AT+LADDR\r\n");
        btReadLine(tsChannel, tmp, sizeof(tmp));
 
        if (btModuleType == BLUETOOTH_JDY_3x) {
            btWrite(tsChannel, "AT+STAT\r\n");
            btReadLine(tsChannel, tmp, sizeof(tmp));
        }
#endif
 
        /* JDY33/JDY31 specific settings */
        /* Reset to defaults */
        btWrite(tsChannel, "AT+DEFAULT\r\n");
        btWaitOk(tsChannel);
 
        /* No serial port status output */
        btWrite(tsChannel, "AT+ENLOG0\r\n");
        btWaitOk(tsChannel);
 
        if (btModuleType == BLUETOOTH_JDY_3x) {
            /* SPP connection with no password */
            btWrite(tsChannel, "AT+TYPE0\r\n");
            btWaitOk(tsChannel);
        }
    }
 
    /* restart with a working baud, then change settings */
    tsChannel->stop();
    chThdSleepMilliseconds(10); // safety
 
    tsChannel->start(baudRates[workingBaudIndex].rate);
 
    if (btModuleType == BLUETOOTH_HC_05)
        chsnprintf(tmp, sizeof(tmp), "AT+NAME=%s\r\n", btName);
    else
        chsnprintf(tmp, sizeof(tmp), "AT+NAME%s\r\n", btName);
    btWrite(tsChannel, tmp);
    if (btWaitOk(tsChannel) != 0) {
        goto cmdFailed;
    }
    if (btModuleType == BLUETOOTH_JDY_3x) {
        /* BLE broadcast name */
        chsnprintf(tmp, sizeof(tmp), "AT+NAMB%s-BLE\r\n", btName);
        btWrite(tsChannel, tmp);
        if (btWaitOk(tsChannel) != 0) {
            goto cmdFailed;
        }
    }
 
    if (btModuleType == BLUETOOTH_HC_05)
        chsnprintf(tmp, sizeof(tmp), "AT+PSWD=%s\r\n", btPinCode);
    else
        chsnprintf(tmp, sizeof(tmp), "AT+PIN%s\r\n", btPinCode);
 
    btWrite(tsChannel, tmp);
    if (btWaitOk(tsChannel) != 0) {
        goto cmdFailed;
    }
 
    if (btModuleType == BLUETOOTH_HC_05)
        chsnprintf(tmp, sizeof(tmp), "AT+UART=%d,0,0\r\n", baudRates[setBaudIdx].rate); // baud rate, 0=(1 stop bit), 0=(no parity bits)
    else
        chsnprintf(tmp, sizeof(tmp), "AT+BAUD%d\r\n", baudRates[setBaudIdx].code);
    btWrite(tsChannel, tmp);
    if (btWaitOk(tsChannel) != 0) {
        goto cmdFailed;
    }
  
    if ((btModuleType == BLUETOOTH_JDY_3x) ||
        (btModuleType == BLUETOOTH_JDY_31)) {
        /* Now reset module to apply new settings */
        btWrite(tsChannel, "AT+RESET\r\n");
        if (btWaitOk(tsChannel) != 0) {
            efiPrintf("JDY3x failed to reset");
        }
    }
 
    efiPrintf("SUCCESS! All commands passed to the Bluetooth module!");
    return;
 
cmdFailed:
    efiPrintf("FAIL! Command %s failed", tmp);
}

Referenced by bluetoothSoftwareDisconnectNotify().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ [struct]

const struct { ... } baudRates[]

Initial value:

= {
    
    {115200, 8},
    {9600, 4},
    {38400, 6},
    {2400, 2},
    {4800, 3},
    {19200, 5},
    {57600, 7}
}

Referenced by bluetoothStart(), findBaudIndex(), runCommands(), and spi_detectBaudRate().

◆ btModuleTimeout

const int btModuleTimeout = TIME_MS2I(2500)

static

Definition at line 52 of file bluetooth.cpp.

Referenced by btReadLine().

◆ btModuleType

bluetooth_module_e btModuleType

Definition at line 31 of file bluetooth.cpp.

Referenced by bluetoothSoftwareDisconnectNotify(), bluetoothStart(), findBaudIndex(), and runCommands().

◆ btName

char btName[20+1]

static

Definition at line 33 of file bluetooth.cpp.

Referenced by bluetoothStart(), and runCommands().

◆ btPinCode

char btPinCode[4+1]

static

Definition at line 34 of file bluetooth.cpp.

Referenced by bluetoothStart(), and runCommands().

◆ btSetupIsRequested

volatile bool btSetupIsRequested = false

static

Definition at line 29 of file bluetooth.cpp.

Referenced by bluetoothSoftwareDisconnectNotify(), and bluetoothStart().

◆ code

uint8_t code

◆ rate

uint32_t rate

Definition at line 39 of file bluetooth.cpp.

Referenced by findBaudIndex(), findCanConfig(), and runCommands().

◆ setBaudIdx

int setBaudIdx = -1

static

Definition at line 32 of file bluetooth.cpp.

Referenced by bluetoothStart(), and runCommands().

◆ workingBaudIndex

uint8_t workingBaudIndex

static

Definition at line 35 of file bluetooth.cpp.

Referenced by runCommands().

Go to the source code of this file.

Detailed Description

Functions

Variables

Function Documentation

◆ bluetoothSoftwareDisconnectNotify()

◆ bluetoothStart()

◆ btBaudOk()

◆ btReadLine()

◆ btWaitOk()

◆ btWrite()

◆ findBaudIndex()

◆ runCommands()

Variable Documentation

◆ [struct]

◆ btModuleTimeout

◆ btModuleType

◆ btName

◆ btPinCode

◆ btSetupIsRequested

◆ code

◆ rate

◆ setBaudIdx

◆ workingBaudIndex