dotstack SDK for PIC24 and PIC32 Getting Started

Transcription

1 dotstack SDK for PIC24 and PIC32 Getting Started Version Copyright 2010 CandleDragon, Inc.

2 1 Overview dotstack is a full featured yet very compact Bluetooth stack. It was designed specifically for use in embedded systems. dotstack Software Development Kit for PIC24 and PIC32 (dotstack SDK) is a collection of software and documentation for implementing Bluetooth connectivity in embedded systems based on a wide range of Microchip PIC24 and PIC32 microcontrollers. The SDK provides the object code of the dotstack Bluetooth stack, header files, documentation, and examples. 2 System Requirements The following is required for development with the dotstack SDK: A Windows PC computer with the Microchip MPLAB development environment version 8.x supporting development for PIC24 and/or PIC32 family of microcontrollers. Java Runtime Environment version 1.6 or later. To build and run the example applications provided with the SDK the following is required: Explorer 16 evaluation board. For PIC24: PIC24FJ256GB110 PIM module. For PIC32: PIC32MX795F512 (or PIC32MX460F512L) PIM module. 3 Setup The SDK is delivered as a ZIP archive. It should be unpacked to a location on a hard drive. Further in this document that location will be referred to as <SDK>. After unpacking the SDK, there will be the following directories at the top level: Directory <SDK>\doc <SDK>\examples <SDK>\freertos <SDK>\pic24 <SDK>\pic32 <SDK>\sdp_compiler Description Documentation. Example code common to both platforms. Source code of the FreeRTOS real-time operating system that is used in examples. dotstack object code, header files and example projects for the PIC24 platform. dotstack object code, header files and example projects for the PIC32 platform. SDP compiler. A program for translating SDP database description from XML format to C source code. 4 Bluetooth Profiles The dotstack SDK supports the following Bluetooth profiles: 2

3 Serial Port Profile (SPP) Human Interface Device Profile (HIDP) Hands Free Profile (HFP) 5 Examples The SDK provides examples for each profile supported by the SDK. Most of the code in the examples is common to both PIC24 and PIC32 platforms. The platform independent part of the example code is located in <SDK>\examples directory. Platform specific part of the code is located in <SDK>\<PLATFORM>\examples. <PLATFORM> is either PIC24 or PIC32. Inside of each platform specific directory there is a subdirectory named common. This subdirectory contains the code that integrates the dotstack library with the platform. It provides platform specific implementation of services required by dotstack. Also, they implement a simple framework for example applications so that most of the example code can be shared between the platforms. Other subdirectories in the platform specific example directory only contain project files for the example applications, one in each subdirectory. There is no source code in those subdirectories. All source code for an example project is combined from the common platform specific part and one of the platform independent examples. The examples use the FreeRTOS real-time operating system. Its source code is located in <SDK>\freertos. It should be noted that an RTOS is not required for dotstack. It can be used with or without it. For more information about FreeRTOS visit To build an example project, follow these steps: 1. Open MPLAB IDE and open one of the example projects. 2. Configure the IDE for a specific device (Configure->Select Device menu). It must be PIC24FJ256GB110 or PIC32MX795F512 (or PIC32MX460F512L). 3. Configure the IDE to use your debugger or programmer. 4. Build the project by selecting Project->Make or Project->Build All menu item. The following examples are provided: SPP example HID Mouse Example HID Keyboard Example Hands-free Example The following sections provide more details for each example. All example applications use four push buttons found on the Explorer 16 evaluation board. In this document these buttons are referred to as Button1, Button2, Button3, and Button4. They correspond to the following elements on the board schematics: 3

4 Button1 Button2 Button3 Button4 S3 S6 S5 S4 It should be noted that because the PIC32 IO pin, connected to switch S5 (Button3), does not have the Change Notification function, it is polled by software to detect when a change occurs. The poll period is 100 ms which results in reaction time significantly slower than the other buttons which are implemented using the Change Notification functionality. 5.1 SPP Example This example demonstrates usage of the Serial Port Profile. The application sends back any character/data received from the remote device. When a button press is detected the name of the button is sent to the remote device. To communicate with this example you can use any terminal program that can open a COM port. On Windows XP you can use Hyper Terminal. On Windows Vista and later, the Hyper Terminal software is not included. On these platform you can use Putty, a free Telnet/SSH software. Latest versions of that software can also open a COM port. It can be downloaded from The Bluetooth PIN code for this example is HID Mouse Example This example uses the HID Profile to implement a device that emulates a computer mouse. Pressing the four buttons on the Explorer 16 board will move the mouse cursor in for directions (left, right, up, down). 5.3 HID Keyboard Example This example uses the HID Profile to implement a device that emulates a computer keyboard. Pressing Button1, Button2, and Button3 will correspond to pressing keys A, B, and C on a real keyboard. Some Bluetooth stacks assume that if a HID device is a keyboard, the user is able to enter an arbitrary PIN code. Due to that they do not let the user specify the keyboard s PIN code using the PC but instead require the user to enter a specific PIN code using the remote keyboard. The Explorer 16 board has only 4 buttons and implementing a full featured keyboard is not possible. Due to this the HID keyboard example cannot be used with such Bluetooth stacks. The stacks that are known to let the user enter the PIN code on the PC and work with the example are Microsoft Bluetooth stack and Apple Bluetooth stack. 4

5 5.4 Hands-free Example This example demonstrated usage of the Hands-Free Profile (HFP). You can use this example with a phone that supports HFP. Most modern phones with the Bluetooth functionality support HFP, however, it was tested so far only with iphone and Android platforms. After pairing and connecting to the phone, the LCD will display three parameters: Signal Strength (S), Roaming Status (R), and Battery Level (B). When there is an incoming call, the caller number (if available) will be shown on the LCD. Pressing Button1 accepts an incoming call or terminates the active call. 5.5 Custom HID Example This example shows how to create a Bluetooth HID device that uses custom HID reports. The SDP database in this example defines the following three custom HID reports: Report ID 0x10 0x11 0x12 Description Two 8-bit fields Three 8-bit fields One 8-bit field Pressing Button1 through Button3 sends a corresponding HID report(0x10-0x12) populated with random data. Pressing Button4 connects the device to the last connected remote device. When a connection is already established, pressing Button4 disconnects from the remote device. In order to view the HID reports sent by this example you can use the accompanying test application. The test application is written for the Windows OS using Visual Studio C It is provided in both source and binary form. The test application is located in <SDK>\examples\custom-hid-test directory. The full path to the binary is: <SDK>\examples\custom-hid-test\Release\CustomHidTest.exe This example was tested on Windows XP and Windows 7 using the Microsoft Bluetooth Stack. 5