This post is older than 2 years and might not be relevant anymore
More Info: Consider searching for newer posts

HID Finger Swipe Functionality (iPhone)

I’m very familiar with the HID keyboard and mouse profile and have built products using it but need direction on how to replicate the functionality of a up/down/left/right finger swipe on a iPhone. Any guidance will be valuable.  Thanks 

Parents
  • What I'm trying to accomplish is exactly what this remote is doing but not sure what type of Bluetooth HID profile it's working with. What it's doing is performing up/down/left/right scroll as if it was a finger swipe.  I think it is acting like a digitizer but it shows up as a keyboard profile and not a mouse.  There is another thread that talks about HID digitizer and has an example project to go with it but its base is on top of mouse. So I'm little confused on what HID profile to focus on.  I do have the packet logs captured from this remote.  Is there a way to capture the report profile from a device?

    www.aliexpress.com/.../4000061114207.html

  • Hi Matthew

    If you have access to the device in question you should be able to connect to it from the nRF Connect mobile app, and read out the HID report descriptor from there. 

    Then you can try to replicate that HID descriptor in your own peripheral implementation. 

    Best regards
    Torbjørn

  • Hi Overbekk,

    Thanks for the reply.  I'm in the process of rapidly growing my knowledge of Bluetooth LE.  I have done what you suggested and not sure where I should pull the feature report from in the nRF Connect App on my iPhone.  I have attached two screen shots to show what the app is revealing for the device.  My goal is to get and recreate the feature report like the example below.  At what point is the feature report sent to the iPhone during the connection and paring?  I have the packet logs that I pulled using the Mac OS X PacketLogger for Bluetooth.  The logs have the connection and paring information and also the info for each button press.  I have also uploaded them in case they help in any way.  As you know they can be viewed through Wireshark but wanted to add this note for others.  I'm going to try and see what the logs tell me but if you have any further advice or information please share.  Thanks...

    0x05, 0x0D,        // Usage Page (Digitizer)
       0x09, 0x04,        // Usage (Touch Screen)
       0xA1, 0x01,        // Collection (Application)
          ....,.....,        //   etc....
          0x95, 0x01,        //   Report Count (1)
          0xB1, 0x02,        //   Feature (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position,Non-volatile)
    0xC0 // End Collection




    0310.RemotePacketLogs.pklg
  • Hi Matthew

    Using the ble_app_hids_mouse example in the SDK you should be able to set up something similar to your remote device, as long as you copy the HID Report descriptor. One possible issue is that iOS in general doesn't support HID mice, only keyboards. 

    The log you sent was very useful, and shows the report descriptor being transferred (packets 100, 103, 106, ... in the log). The descriptor appears to identify the device as a mouse, so I am surprised this would work, but I guess you have verified that the device can be used to control the phone?

    The screenshots you sent don't appear to show the HID service at all, only the standard Generic Access, Generic Attribute and Battery services. Since the HID service is handled by the OS directly it is probably made inaccessible by the system. 

    An alternative is to use a Nordic devkit or dongle connected to your PC/Mac, and use the nRF Connect for Desktop application to connect to it. Then you should be able to see all the services. 

    Best regards
    Torbjørn

  • Hi Ovrebekk,

    You are correct about the iPhone not supporting HID mouse unless enable now in the Accessibility options.  But when I connect the remote to the computer it shows up as a keyboard and not a mouse.  Now I think you recognize my struggle and need the report descriptor.

    If I understand you correct.  I will use nRF Connect on my Mac that is connected to my nRF52832 devkit and have the remote connect and pair to the devkit so I can extract the info?  I'm guessing there is a sample project that allows for me to host as a master on the devkit?

    I will review the packet logs and try to figure out what you are suggesting.  Thanks...

Reply
  • Hi Ovrebekk,

    You are correct about the iPhone not supporting HID mouse unless enable now in the Accessibility options.  But when I connect the remote to the computer it shows up as a keyboard and not a mouse.  Now I think you recognize my struggle and need the report descriptor.

    If I understand you correct.  I will use nRF Connect on my Mac that is connected to my nRF52832 devkit and have the remote connect and pair to the devkit so I can extract the info?  I'm guessing there is a sample project that allows for me to host as a master on the devkit?

    I will review the packet logs and try to figure out what you are suggesting.  Thanks...

Children
  • Hi Matthew

    Did you check packets 100, 103, 106 etc like I mentioned?

    Packet 100 starts with 0x05, 0x0D, 0x09, 0x02, 0xA1, 0x01 .., which is clearly the start of the HID descriptor. It is quite similar to the descriptor you shared below, except the usage is 0x02 (mouse) instead of 0x04 (touch screen). 

    Looking at the log again the entire descriptor seems to be sent across the following packets: 100, 103, 106, 109, 112 and 115.

    Best regards
    Torbjørn

  • Hi Ovrebekk,

    I received a new remote in the mail today that was better quality and is performing the same function I'm trying to duplicate.  This remote has a nRF51822 instead of some cheap China IC.  I took everything that you have educated me on and derived to the following information.  I was able to extract the report and also attempted to fill it out with comments.  It looks like it is presenting itself as a Digitizer and performing a single finger touch swipe effect.  I was able to capture the data for each button press.  I'm assuming the data is representing the finger press and the sliding across the screen.  I'm thinking I need to take the ble_app_hids_keyboard example and add this report then try sending the raw data. I say keyboard because the remote shows up as keyboard on the computer and I plan to use this with my current product that is a keyboard.  Also, I'm having trouble designing the packet structure from this report just for the digitizer.  I haven't quite wrapped my mind around how it works. Do you have any recommendations?  This has been a great practice to learn in depth how all this works.  Your feedback has been great and really appreciate it.

    My attempt to start a packet structure.

    typedef PACKED_STRUCT
    {

    uint8_t report_id:
    uint8_t tip_switch : 1;
    uint8_t range : 1; // Not sure if this is right
    uint16_t x;
    uint16_t y;
    ???? width; // Not sure if this is needed
    ???? height; // Not sure if this is needed
    } digitizer_report_t;

    Packet 1: 050D 0901 A101 8501 0922 A102 0942 1500 2501 7501 9501
    Packet 2: 8102 0932 8102 9506 8103 0501 26E8 0375 1095 0155 0065
    Packet 3: 0009 3035 0046 E803 8102 0931 46E8 0381 02C0 050D 0948
    Packet 4: 0949 9502 8102 C005 0C09 01A1 0185 0209 E909 EA09 E209
    Packet 5: B509 B60A 2402 09CD 0930 0A23 0209 4015 0125 0C75 1095
    Packet 6: 0181 00C0 0501 0906 A101 8503 0507 19E0 29E7 1500 2501
    Packet 7: 7501 9508 8102 7508 9501 1500 25F4 0507 1900 29F4 8100
    Packet 8: C0

    www.usb.org/.../hut1_12v2.pdf

    0x05, 0x0D, // USAGE_PAGE (Digitizer) 
    0x09, 0x01, // USAGE (Digitizer)
    0xA1, 0x01, // Collection (Application)
    0x85, 0x01, // REPORT_ID 1
    0x09, 0x22, // USAGE (Finger)
    0xA1, 0x02, // Collection (Logical)
    0x09, 0x42, // USAGE (Tip Switch)
    0x15, 0x00, // LOGICAL_MINIMUM (0)
    0x25, 0x01, // LOGICAL_MAXIMUM (1)
    0x75, 0x01, // REPORT_SIZE (1)
    0x95, 0x01, // REPORT_COUNT (1)
    0x81, 0x02, // INPUT (Data,Var,Abs)
    0x09, 0x32, // USAGE (In Range)
    0x81, 0x02, // INPUT (Data,Var,Abs)
    0x95, 0x06, // REPORT_COUNT (6)
    0x81, 0x03, // INPUT (Cnst,Ary,Abs)
    0x05, 0x01, // USAGE_PAGE (Generic Desktop)
    0x26, 0xE8, 0x03, // LOGICAL_MAXIMUM (0x03E8 = 1000)
    0x75, 0x10, // REPORT_SIZE (16)
    0x95, 0x01, // REPORT_COUNT (1)
    0x55, 0x00, // UNIT_EXPONENT (0)
    0x65, 0x00, // UNIT(Inch, EngLinear)
    0x09, 0x30, // USAGE (X)
    0x35, 0x00, // PHYSICAL_MINIMUM (0)
    0x46, 0xE8, 0x03, // PHYSICAL_MAXIMUM (0x03E8 = 1000)
    0x81, 0x02, // INPUT (Data,Var,Abs)
    0x09, 0x31, // USAGE (Y)
    0x46, 0xE8, 0x03, // PHYSICAL_MAXIMUM (0x03E8 = 1000)
    0x81, 0x02, // INPUT (Data,Var,Abs)
    0xC0, // END_COLLECTION
    0x05, 0x0D, // USAGE_PAGE (Digitizer)
    0x09, 0x48, // USAGE (Width)
    0x09, 0x49, // USAGE (Height)
    0x95, 0x02, // REPORT_COUNT (2)
    0x81, 0x02, // INPUT (Data,Var,Abs)
    0xC0, // END_COLLECTION
    
    0x05, 0x0C, // USAGE_PAGE (Consumer Devices)
    0x09, 0x01, // USAGE_(Consumer Control)
    0xA1, 0x01, // COLLECTION (Application)
    0x85, 0x02, // REPORT_ID 2
    0x09, 0xE9, // USAGE (Volume Increment)
    0x09, 0xEA, // USAGE (Volume Decrement)
    0x09, 0xE2, // USAGE (Mute)
    0x09, 0xB5, // USAGE (Scan Next Track)
    0x09, 0xB6, // USAGE (Scan Previous Track)
    0x0A, 0x24, 0x02, // USAGE (WWW Back)
    0x09, 0xCD, // USAGE (Play/Pause)
    0x09, 0x30, // USAGE (Power)
    0x0A, 0x23, 0x02, // USAGE (WWW Home)
    0x09, 0x40, // USAGE (Menu)
    0x15, 0x01, // LOGICAL_MINIMUM (1)
    0x25, 0x0C, // LOGICAL_MAXIMUM (12)
    0x75, 0x10, // REPORT_SIZE (16)
    0x95, 0x01, // REPORT_COUNT (1)
    0x81, 0x00, // INPUT (Data,Ary,Abs)
    0xC0, // END_COLLECTION
    
    0x05, 0x01, // USAGE_PAGE (Generic Desktop)
    0x09, 0x06, // USAGE (Keyboard)
    0xA1, 0x01, // Collection (Application)
    0x85, 0x03, // REPORT_ID 3
    0x05, 0x07, // USAGE_PAGE (Keyboard)
    0x19, 0xE0, // USAGE_MINIMUM (Keyboard LeftControl)
    0x29, 0xE7, // USAGE_MAXIMUM (Keyboard Right GUI)
    0x15, 0x00, // LOGICAL_MINIMUM (0)
    0x25, 0x01, // LOGICAL_MAXIMUM (1)
    0x75, 0x01, // REPORT_SIZE (1)
    0x95, 0x08, // REPORT_COUNT (8)
    0x81, 0x02, // INPUT (Data,Var,Abs)
    0x75, 0x08, // REPORT_SIZE (8)
    0x95, 0x01, // REPORT_COUNT (1)
    0x15, 0x00, // LOGICAL_MINIMUM (0)
    0x25, 0xF4, // LOGICAL_MAXIMUM (244)
    0x05, 0x07, // USAGE_PAGE (Keyboard)
    0x19, 0x00, // USAGE_MINIMUM (Reserved (no event indicated))
    0x29, 0xF4, // USAGE_MAXIMUM (????)
    0x81, 0x00, // INPUT (Data,Ary,Abs)
    0xC0 // END_COLLECTION
    
    ## UP Button Values ## 
    Packet 1: 07F4 0120 038E 038E 03 
    Packet 2: 07F4 0102 038E 038E 03 
    Packet 3: 07F4 01E4 028E 038E 03 
    Packet 4: 07F4 01C6 028E 038E 03 
    Packet 5: 07F4 01A8 028E 038E 03 
    Packet 6: 07F4 018A 028E 038E 03 
    Packet 7: 07F4 016C 028E 038E 03 
    Packet 8: 07F4 014E 028E 038E 03 
    Packet 9: 07F4 0130 028E 038E 03 
    Packet 10: 07F4 0112 028E 038E 03 
    Packet 11: 07F4 01F4 018E 038E 03 
    Packet 12: 07F4 01D6 018E 038E 03 
    Packet 13: 07F4 01B8 018E 038E 03 
    Packet 14: 07F4 019A 018E 038E 03 
    Packet 15: 07F4 017C 018E 038E 03 
    Packet 16: 07F4 015E 018E 038E 03 
    Packet 17: 07F4 0140 018E 038E 03 
    Packet 18: 00F4 0140 018E 038E 03
    
    ## Down Button Values ## 
    Packet 1: 07F4 012C 018E 038E 03 
    Packet 2: 07F4 014A 018E 038E 03 
    Packet 3: 07F4 0168 018E 038E 03 
    Packet 4: 07F4 0186 018E 038E 03 
    Packet 5: 07F4 01A4 018E 038E 03 
    Packet 6: 07F4 01C2 018E 038E 03
    Packet 7: 07F4 01E0 018E 038E 03 
    Packet 8: 07F4 01FE 018E 038E 03 
    Packet 9: 07F4 011C 028E 038E 03 
    Packet 10: 07F4 013A 028E 038E 03 
    Packet 11: 07F4 0158 028E 038E 03 
    Packet 12: 07F4 0176 028E 038E 03 
    Packet 13: 07F4 0194 028E 038E 03 
    Packet 14: 07F4 01B2 028E 038E 03 
    Packet 15: 07F4 01D0 028E 038E 03 
    Packet 16: 07F4 01EE 028E 038E 03 
    Packet 17: 07F4 010C 038E 038E 03 
    Packet 18: 00F4 010C 038E 038E 03
    
    ## Left Button Values ## 
    Packet 1: 0720 032C 018E 038E 03 
    Packet 2: 07BC 022C 018E 038E 03 
    Packet 3: 0758 022C 018E 038E 03 
    Packet 4: 07F4 012C 018E 038E 03 
    Packet 5: 0790 012C 018E 038E 03 
    Packet 6: 072C 012C 018E 038E 03 
    Packet 7: 002C 012C 018E 038E 03 
    Packet 8: 002C 012C 018E 038E 03
    
    ## Right Button Values ##
    Packet 1: 07C8 002C 018E 038E 03 
    Packet 2: 072C 012C 018E 038E 03 
    Packet 3: 0790 012C 018E 038E 03 
    Packet 4: 07F4 012C 018E 038E 03 
    Packet 5: 0758 022C 018E 038E 03 
    Packet 6: 07BC 022C 018E 038E 03 
    Packet 7: 00BC 022C 018E 038E 03 
    Packet 8: 002C 012C 018E 038E 03

  • Trying to learn fast on how to read the descriptor file and figure out the packet layout or just the number of bytes.  As mentioned before I was able to capture the packet logs for a finger up swipe.  Below is just one example of that and I'm trying to figure out how it maps into the packet.  I'm seeing a count of 9 bytes in the data packet but don't see how to map that back to the descriptor.  Have had no luck finding a good tutorial on this. 

    I have started to use the keyboard example project and merge the digitizer report with it.  It seem that there have been many people ask for help around merging keyboard and mouse or keyboard and digitizer but with no luck or they just didn't share their success with the community.  Seems to be a pretty confusing topic.  Is there any working examples that you know of?  I have taken what I can find and attempted to present both reports to the iPhone and at least have keyboard continue to work. So far I think it's working with the new report descriptors added and the digitizer service initialized because the keyboard functionality is still working.  I just need to figure out how the digitizer packet looks and how to send the data.

    Thanks for your help or advice.  I will continue to contribute to this thread so if I get it working I will post the working code so other may benefit from this.

    ## Packet Data Captured ##
    Value: 07F4 0120 038E 038E 03
    Length: 0x000C (12) [ 1B 27 00 07 F4 01 20 03 8E 03 8E 03 ] RECV

    0x05, 0x0D,       // USAGE_PAGE (Digitizer) 
    0x09, 0x01,       // USAGE (Digitizer)
    0xA1, 0x01,       // Collection (Application)
    0x85, 0x01,       //    REPORT_ID 1
    0x09, 0x22,       //    USAGE (Finger)
    0xA1, 0x02,       //    Collection (Logical)
    0x09, 0x42,       //	   USAGE (Tip Switch)
    0x15, 0x00,       //	   LOGICAL_MINIMUM (0)
    0x25, 0x01,       //       LOGICAL_MAXIMUM (1)
    0x75, 0x01,       //	   REPORT_SIZE (1)
    0x95, 0x01,       //	   REPORT_COUNT (1)
    0x81, 0x02,       //       INPUT (Data,Var,Abs)
    0x09, 0x32,       //       USAGE (In Range)
    0x81, 0x02,       //       INPUT (Data,Var,Abs)
    0x95, 0x06,       //       REPORT_COUNT (6)
    0x81, 0x03,       //       INPUT (Cnst,Ary,Abs)
    0x05, 0x01,       //       USAGE_PAGE (Generic Desktop)
    0x26, 0xE8, 0x03, //       LOGICAL_MAXIMUM (0x03E8 = 1000)
    0x75, 0x10,       //       REPORT_SIZE (16)
    0x95, 0x01,       //       REPORT_COUNT (1)
    0x55, 0x00,       //       UNIT_EXPONENT (0)
    0x65, 0x00,       //       UNIT(Inch, EngLinear)
    0x09, 0x30,       //       USAGE (X)
    0x35, 0x00,       //       PHYSICAL_MINIMUM (0)
    0x46, 0xE8, 0x03, //       PHYSICAL_MAXIMUM (0x03E8 = 1000)
    0x81, 0x02,       //       INPUT (Data,Var,Abs)
    0x09, 0x31,       //       USAGE (Y)
    0x46, 0xE8, 0x03, //       PHYSICAL_MAXIMUM (0x03E8 = 1000)
    0x81, 0x02,       //       INPUT (Data,Var,Abs)
    0xC0,             //    END_COLLECTION
    0x05, 0x0D,       //    USAGE_PAGE (Digitizer)
    0x09, 0x48,       //    USAGE (Width)
    0x09, 0x49,       //    USAGE (Height)
    0x95, 0x02,       //    REPORT_COUNT (2)
    0x81, 0x02,       //    INPUT (Data,Var,Abs)
    0xC0,             // END_COLLECTION

    byte[0] = 0x01 Report ID
    byte[1] = Contains bit fields for various input
        bit 0 = Tip switch
        bit 1 = In range indicator
        bit 2 = Not Used
        bit 3 = Not Used
        bit 4 = Not Used
        bit 5 = Not Used
        bit 6 = Not Used
        bit 7 = Not Used
    byte[2] = X Coordinate MSB
    byte[3] = X Coordinate LSB
    byte[4] = Y Coordinate MSB
    byte[5] = Y Coordinate LSB

    /**
     * Copyright (c) 2012 - 2019, Nordic Semiconductor ASA
     *
     * All rights reserved.
     *
     * Redistribution and use in source and binary forms, with or without modification,
    /** @file
     *
     * @defgroup ble_sdk_app_hids_keyboard_main main.c
     * @{
     * @ingroup ble_sdk_app_hids_keyboard
     * @brief HID Keyboard Sample Application main file.
     *
     * This file contains is the source code for a sample application using the HID, Battery and Device
     * Information Services for implementing a simple keyboard functionality.
     * Pressing Button 0 will send text 'hello' to the connected peer. On receiving output report,
     * it toggles the state of LED 2 on the mother board based on whether or not Caps Lock is on.
     * This application uses the @ref app_scheduler.
     *
     * Also it would accept pairing requests from any peer device.
     */
    
    #include <stdint.h>
    #include <string.h>
    #include "nordic_common.h"
    #include "nrf.h"
    #include "nrf_assert.h"
    #include "app_error.h"
    #include "ble.h"
    #include "ble_err.h"
    #include "ble_hci.h"
    #include "ble_srv_common.h"
    #include "ble_advertising.h"
    #include "ble_advdata.h"
    #include "ble_hids.h"
    #include "ble_bas.h"
    #include "ble_dis.h"
    #include "ble_conn_params.h"
    #include "sensorsim.h"
    #include "bsp_btn_ble.h"
    #include "app_scheduler.h"
    #include "nrf_sdh.h"
    #include "nrf_sdh_soc.h"
    #include "nrf_sdh_ble.h"
    #include "app_timer.h"
    #include "peer_manager.h"
    #include "fds.h"
    #include "ble_conn_state.h"
    #include "nrf_ble_gatt.h"
    #include "nrf_ble_qwr.h"
    #include "nrf_pwr_mgmt.h"
    #include "peer_manager_handler.h"
    
    #include "nrf_log.h"
    #include "nrf_log_ctrl.h"
    #include "nrf_log_default_backends.h"
    
    #define SHIFT_BUTTON_ID                     1                                          /**< Button used as 'SHIFT' Key. */
    
    #define DEVICE_NAME                         "Nordic_Keyboard"                          /**< Name of device. Will be included in the advertising data. */
    #define MANUFACTURER_NAME                   "NordicSemiconductor"                      /**< Manufacturer. Will be passed to Device Information Service. */
    
    #define APP_BLE_OBSERVER_PRIO               3                                          /**< Application's BLE observer priority. You shouldn't need to modify this value. */
    #define APP_BLE_CONN_CFG_TAG                1                                          /**< A tag identifying the SoftDevice BLE configuration. */
    
    #define BATTERY_LEVEL_MEAS_INTERVAL         APP_TIMER_TICKS(2000)                      /**< Battery level measurement interval (ticks). */
    #define MIN_BATTERY_LEVEL                   81                                         /**< Minimum simulated battery level. */
    #define MAX_BATTERY_LEVEL                   100                                        /**< Maximum simulated battery level. */
    #define BATTERY_LEVEL_INCREMENT             1                                          /**< Increment between each simulated battery level measurement. */
    
    #define PNP_ID_VENDOR_ID_SOURCE             0x02                                       /**< Vendor ID Source. */
    #define PNP_ID_VENDOR_ID                    0x1915                                     /**< Vendor ID. */
    #define PNP_ID_PRODUCT_ID                   0xEEEE                                     /**< Product ID. */
    #define PNP_ID_PRODUCT_VERSION              0x0001                                     /**< Product Version. */
    
    #define APP_ADV_FAST_INTERVAL               0x0028                                     /**< Fast advertising interval (in units of 0.625 ms. This value corresponds to 25 ms.). */
    #define APP_ADV_SLOW_INTERVAL               0x0C80                                     /**< Slow advertising interval (in units of 0.625 ms. This value corrsponds to 2 seconds). */
    
    #define APP_ADV_FAST_DURATION               3000                                       /**< The advertising duration of fast advertising in units of 10 milliseconds. */
    #define APP_ADV_SLOW_DURATION               18000                                      /**< The advertising duration of slow advertising in units of 10 milliseconds. */
    
    
    /*lint -emacro(524, MIN_CONN_INTERVAL) // Loss of precision */
    #define MIN_CONN_INTERVAL                   MSEC_TO_UNITS(7.5, UNIT_1_25_MS)           /**< Minimum connection interval (7.5 ms) */
    #define MAX_CONN_INTERVAL                   MSEC_TO_UNITS(30, UNIT_1_25_MS)            /**< Maximum connection interval (30 ms). */
    #define SLAVE_LATENCY                       6                                          /**< Slave latency. */
    #define CONN_SUP_TIMEOUT                    MSEC_TO_UNITS(430, UNIT_10_MS)             /**< Connection supervisory timeout (430 ms). */
    
    #define FIRST_CONN_PARAMS_UPDATE_DELAY      APP_TIMER_TICKS(5000)                      /**< Time from initiating event (connect or start of notification) to first time sd_ble_gap_conn_param_update is called (5 seconds). */
    #define NEXT_CONN_PARAMS_UPDATE_DELAY       APP_TIMER_TICKS(30000)                     /**< Time between each call to sd_ble_gap_conn_param_update after the first call (30 seconds). */
    #define MAX_CONN_PARAMS_UPDATE_COUNT        3                                          /**< Number of attempts before giving up the connection parameter negotiation. */
    
    #define SEC_PARAM_BOND                      1                                          /**< Perform bonding. */
    #define SEC_PARAM_MITM                      0                                          /**< Man In The Middle protection not required. */
    #define SEC_PARAM_LESC                      0                                          /**< LE Secure Connections not enabled. */
    #define SEC_PARAM_KEYPRESS                  0                                          /**< Keypress notifications not enabled. */
    #define SEC_PARAM_IO_CAPABILITIES           BLE_GAP_IO_CAPS_NONE                       /**< No I/O capabilities. */
    #define SEC_PARAM_OOB                       0                                          /**< Out Of Band data not available. */
    #define SEC_PARAM_MIN_KEY_SIZE              7                                          /**< Minimum encryption key size. */
    #define SEC_PARAM_MAX_KEY_SIZE              16                                         /**< Maximum encryption key size. */
    
    #define ENABLE_DIGITIZER
    
    #ifdef ENABLE_DIGITIZER
      #define INPUT_REPORT_COUNT                2                                          /**< Number of input reports in this application. */
      #define INPUT_REP_REF_DIGITIZER_ID        2
      #define INPUT_REPORT_DIG_MAX_LEN          1
      #define INPUT_REPORT_DIG_INDEX            1                                          /**< Index of Input Report. */
    #else
      #define INPUT_REPORT_COUNT                1                                          /**< Number of input reports in this application. */
    #endif
    
    #define OUTPUT_REPORT_INDEX                 0                                          /**< Index of Output Report. */
    #define OUTPUT_REPORT_MAX_LEN               1                                          /**< Maximum length of Output Report. */
    #define INPUT_REPORT_KEYS_INDEX             0                                          /**< Index of Input Report. */
    #define OUTPUT_REPORT_BIT_MASK_CAPS_LOCK    0x02                                       /**< CAPS LOCK bit in Output Report (based on 'LED Page (0x08)' of the Universal Serial Bus HID Usage Tables). */
    #define INPUT_REP_REF_KEYBOARD_ID           1                                          /**< Id of reference to Keyboard Input Report. */
    #define OUTPUT_REP_REF_ID                   0                                          /**< Id of reference to Keyboard Output Report. */
    #define FEATURE_REP_REF_ID                  0                                          /**< ID of reference to Keyboard Feature Report. */
    #define FEATURE_REPORT_MAX_LEN              2                                          /**< Maximum length of Feature Report. */
    #define FEATURE_REPORT_INDEX                0                                          /**< Index of Feature Report. */
    
    #define MAX_BUFFER_ENTRIES                  5                                          /**< Number of elements that can be enqueued */
    
    #define BASE_USB_HID_SPEC_VERSION           0x0101                                     /**< Version number of base USB HID Specification implemented by this application. */
    
    #define INPUT_REPORT_KEYS_MAX_LEN           8                                          /**< Maximum length of the Input Report characteristic. */
    
    #define DEAD_BEEF                           0xDEADBEEF                                 /**< Value used as error code on stack dump, can be used to identify stack location on stack unwind. */
    
    #define SCHED_MAX_EVENT_DATA_SIZE           APP_TIMER_SCHED_EVENT_DATA_SIZE            /**< Maximum size of scheduler events. */
    #ifdef SVCALL_AS_NORMAL_FUNCTION
    #define SCHED_QUEUE_SIZE                    20                                         /**< Maximum number of events in the scheduler queue. More is needed in case of Serialization. */
    #else
    #define SCHED_QUEUE_SIZE                    10                                         /**< Maximum number of events in the scheduler queue. */
    #endif
    
    #define MODIFIER_KEY_POS                    0                                          /**< Position of the modifier byte in the Input Report. */
    #define SCAN_CODE_POS                       2                                          /**< The start position of the key scan code in a HID Report. */
    #define SHIFT_KEY_CODE                      0x02                                       /**< Key code indicating the press of the Shift Key. */
    
    #define MAX_KEYS_IN_ONE_REPORT              (INPUT_REPORT_KEYS_MAX_LEN - SCAN_CODE_POS)/**< Maximum number of key presses that can be sent in one Input Report. */
    
    
    /**Buffer queue access macros
     *
     * @{ */
    /** Initialization of buffer list */
    #define BUFFER_LIST_INIT()     \
        do                         \
        {                          \
            buffer_list.rp    = 0; \
            buffer_list.wp    = 0; \
            buffer_list.count = 0; \
        } while (0)
    
    /** Provide status of data list is full or not */
    #define BUFFER_LIST_FULL() \
        ((MAX_BUFFER_ENTRIES == buffer_list.count - 1) ? true : false)
    
    /** Provides status of buffer list is empty or not */
    #define BUFFER_LIST_EMPTY() \
        ((0 == buffer_list.count) ? true : false)
    
    #define BUFFER_ELEMENT_INIT(i)                 \
        do                                         \
        {                                          \
            buffer_list.buffer[(i)].p_data = NULL; \
        } while (0)
    
    /** @} */
    
    /** Abstracts buffer element */
    typedef struct hid_key_buffer
    {
        uint8_t      data_offset; /**< Max Data that can be buffered for all entries */
        uint8_t      data_len;    /**< Total length of data */
        uint8_t    * p_data;      /**< Scanned key pattern */
        ble_hids_t * p_instance;  /**< Identifies peer and service instance */
    } buffer_entry_t;
    
    STATIC_ASSERT(sizeof(buffer_entry_t) % 4 == 0);
    
    /** Circular buffer list */
    typedef struct
    {
        buffer_entry_t buffer[MAX_BUFFER_ENTRIES]; /**< Maximum number of entries that can enqueued in the list */
        uint8_t        rp;                         /**< Index to the read location */
        uint8_t        wp;                         /**< Index to write location */
        uint8_t        count;                      /**< Number of elements in the list */
    } buffer_list_t;
    
    STATIC_ASSERT(sizeof(buffer_list_t) % 4 == 0);
    
    
    APP_TIMER_DEF(m_battery_timer_id);                                  /**< Battery timer. */
    
    BLE_HIDS_DEF(m_hids,                                                /**< Structure used to identify the HID service. */
                 NRF_SDH_BLE_TOTAL_LINK_COUNT,
                 INPUT_REPORT_KEYS_MAX_LEN,
                 INPUT_REPORT_DIG_MAX_LEN,
                 OUTPUT_REPORT_MAX_LEN,
                 FEATURE_REPORT_MAX_LEN);
    BLE_BAS_DEF(m_bas);                                                 /**< Structure used to identify the battery service. */
    NRF_BLE_GATT_DEF(m_gatt);                                           /**< GATT module instance. */
    NRF_BLE_QWR_DEF(m_qwr);                                             /**< Context for the Queued Write module.*/
    BLE_ADVERTISING_DEF(m_advertising);                                 /**< Advertising module instance. */
    
    static bool              m_in_boot_mode = false;                    /**< Current protocol mode. */
    static uint16_t          m_conn_handle  = BLE_CONN_HANDLE_INVALID;  /**< Handle of the current connection. */
    static sensorsim_cfg_t   m_battery_sim_cfg;                         /**< Battery Level sensor simulator configuration. */
    static sensorsim_state_t m_battery_sim_state;                       /**< Battery Level sensor simulator state. */
    static bool              m_caps_on = false;                         /**< Variable to indicate if Caps Lock is turned on. */
    static pm_peer_id_t      m_peer_id;                                 /**< Device reference handle to the current bonded central. */
    static buffer_list_t     buffer_list;                               /**< List to enqueue not just data to be sent, but also related information like the handle, connection handle etc */
    
    static ble_uuid_t m_adv_uuids[] = {{BLE_UUID_HUMAN_INTERFACE_DEVICE_SERVICE, BLE_UUID_TYPE_BLE}};
    
    static uint8_t m_sample_key_press_scan_str[] = /**< Key pattern to be sent when the key press button has been pushed. */
    {
        0x0b,       /* Key h */
        0x08,       /* Key e */
        0x0f,       /* Key l */
        0x0f,       /* Key l */
        0x12,       /* Key o */
        0x28        /* Key Return */
    };
    
    static uint8_t m_caps_on_key_scan_str[] = /**< Key pattern to be sent when the output report has been written with the CAPS LOCK bit set. */
    {
        0x06,       /* Key C */
        0x04,       /* Key a */
        0x13,       /* Key p */
        0x16,       /* Key s */
        0x12,       /* Key o */
        0x11,       /* Key n */
    };
    
    static uint8_t m_caps_off_key_scan_str[] = /**< Key pattern to be sent when the output report has been written with the CAPS LOCK bit cleared. */
    {
        0x06,       /* Key C */
        0x04,       /* Key a */
        0x13,       /* Key p */
        0x16,       /* Key s */
        0x12,       /* Key o */
        0x09,       /* Key f */
    };
    
    
    
    static void on_hids_evt(ble_hids_t * p_hids, ble_hids_evt_t * p_evt);
    
    /**@brief Callback function for asserts in the SoftDevice.
     *
     * @details This function will be called in case of an assert in the SoftDevice.
     *
     * @warning This handler is an example only and does not fit a final product. You need to analyze
     *          how your product is supposed to react in case of Assert.
     * @warning On assert from the SoftDevice, the system can only recover on reset.
     *
     * @param[in]   line_num   Line number of the failing ASSERT call.
     * @param[in]   file_name  File name of the failing ASSERT call.
     */
    void assert_nrf_callback(uint16_t line_num, const uint8_t * p_file_name)
    {
        app_error_handler(DEAD_BEEF, line_num, p_file_name);
    }
    
    
    /**@brief Function for setting filtered whitelist.
     *
     * @param[in] skip  Filter passed to @ref pm_peer_id_list.
     */
    static void whitelist_set(pm_peer_id_list_skip_t skip)
    {
        pm_peer_id_t peer_ids[BLE_GAP_WHITELIST_ADDR_MAX_COUNT];
        uint32_t     peer_id_count = BLE_GAP_WHITELIST_ADDR_MAX_COUNT;
    
        ret_code_t err_code = pm_peer_id_list(peer_ids, &peer_id_count, PM_PEER_ID_INVALID, skip);
        APP_ERROR_CHECK(err_code);
    
        NRF_LOG_INFO("\tm_whitelist_peer_cnt %d, MAX_PEERS_WLIST %d",
                       peer_id_count + 1,
                       BLE_GAP_WHITELIST_ADDR_MAX_COUNT); 
    
        err_code = pm_whitelist_set(peer_ids, peer_id_count);
        APP_ERROR_CHECK(err_code);
    }
    
    
    /**@brief Function for setting filtered device identities.
     *
     * @param[in] skip  Filter passed to @ref pm_peer_id_list.
     */
    static void identities_set(pm_peer_id_list_skip_t skip)
    {
        pm_peer_id_t peer_ids[BLE_GAP_DEVICE_IDENTITIES_MAX_COUNT];
        uint32_t     peer_id_count = BLE_GAP_DEVICE_IDENTITIES_MAX_COUNT;
    
        ret_code_t err_code = pm_peer_id_list(peer_ids, &peer_id_count, PM_PEER_ID_INVALID, skip);
        APP_ERROR_CHECK(err_code);
    
        err_code = pm_device_identities_list_set(peer_ids, peer_id_count);
        APP_ERROR_CHECK(err_code);
    }
    
    
    /**@brief Clear bond information from persistent storage.
     */
    static void delete_bonds(void)
    {
        ret_code_t err_code;
    
        NRF_LOG_INFO("Erase bonds!");
    
        err_code = pm_peers_delete();
        APP_ERROR_CHECK(err_code);
    }
    
    
    /**@brief Function for starting advertising.
     */
    static void advertising_start(bool erase_bonds)
    {
        if (erase_bonds == true)
        {
            delete_bonds();
            // Advertising is started by PM_EVT_PEERS_DELETE_SUCCEEDED event.
        }
        else
        {
            whitelist_set(PM_PEER_ID_LIST_SKIP_NO_ID_ADDR);
    
            ret_code_t ret = ble_advertising_start(&m_advertising, BLE_ADV_MODE_FAST);
            APP_ERROR_CHECK(ret);
        }
    }
    
    
    /**@brief Function for handling Peer Manager events.
     *
     * @param[in] p_evt  Peer Manager event.
     */
    static void pm_evt_handler(pm_evt_t const * p_evt)
    {
        pm_handler_on_pm_evt(p_evt);
        pm_handler_flash_clean(p_evt);
    
        switch (p_evt->evt_id)
        {
            case PM_EVT_PEERS_DELETE_SUCCEEDED:
                advertising_start(false);
                break;
    
            case PM_EVT_PEER_DATA_UPDATE_SUCCEEDED:
                if (     p_evt->params.peer_data_update_succeeded.flash_changed
                     && (p_evt->params.peer_data_update_succeeded.data_id == PM_PEER_DATA_ID_BONDING))
                {
                    NRF_LOG_INFO("New Bond, add the peer to the whitelist if possible");
                    // Note: You should check on what kind of white list policy your application should use.
    
                    whitelist_set(PM_PEER_ID_LIST_SKIP_NO_ID_ADDR);
                }
                break;
    
            default:
                break;
        }
    }
    
    
    /**@brief Function for handling Service errors.
     *
     * @details A pointer to this function will be passed to each service which may need to inform the
     *          application about an error.
     *
     * @param[in]   nrf_error   Error code containing information about what went wrong.
     */
    static void service_error_handler(uint32_t nrf_error)
    {
        APP_ERROR_HANDLER(nrf_error);
    }
    
    
    /**@brief Function for handling advertising errors.
     *
     * @param[in] nrf_error  Error code containing information about what went wrong.
     */
    static void ble_advertising_error_handler(uint32_t nrf_error)
    {
        APP_ERROR_HANDLER(nrf_error);
    }
    
    
    /**@brief Function for performing a battery measurement, and update the Battery Level characteristic in the Battery Service.
     */
    static void battery_level_update(void)
    {
        ret_code_t err_code;
        uint8_t  battery_level;
    
        battery_level = (uint8_t)sensorsim_measure(&m_battery_sim_state, &m_battery_sim_cfg);
    
        err_code = ble_bas_battery_level_update(&m_bas, battery_level, BLE_CONN_HANDLE_ALL);
        if ((err_code != NRF_SUCCESS) &&
            (err_code != NRF_ERROR_BUSY) &&
            (err_code != NRF_ERROR_RESOURCES) &&
            (err_code != NRF_ERROR_FORBIDDEN) &&
            (err_code != NRF_ERROR_INVALID_STATE) &&
            (err_code != BLE_ERROR_GATTS_SYS_ATTR_MISSING)
           )
        {
            APP_ERROR_HANDLER(err_code);
        }
    }
    
    
    /**@brief Function for handling the Battery measurement timer timeout.
     *
     * @details This function will be called each time the battery level measurement timer expires.
     *
     * @param[in]   p_context   Pointer used for passing some arbitrary information (context) from the
     *                          app_start_timer() call to the timeout handler.
     */
    static void battery_level_meas_timeout_handler(void * p_context)
    {
        UNUSED_PARAMETER(p_context);
        battery_level_update();
    }
    
    
    /**@brief Function for the Timer initialization.
     *
     * @details Initializes the timer module.
     */
    static void timers_init(void)
    {
        ret_code_t err_code;
    
        err_code = app_timer_init();
        APP_ERROR_CHECK(err_code);
    
        // Create battery timer.
        err_code = app_timer_create(&m_battery_timer_id,
                                    APP_TIMER_MODE_REPEATED,
                                    battery_level_meas_timeout_handler);
        APP_ERROR_CHECK(err_code);
    }
    
    
    /**@brief Function for the GAP initialization.
     *
     * @details This function sets up all the necessary GAP (Generic Access Profile) parameters of the
     *          device including the device name, appearance, and the preferred connection parameters.
     */
    static void gap_params_init(void)
    {
        ret_code_t              err_code;
        ble_gap_conn_params_t   gap_conn_params;
        ble_gap_conn_sec_mode_t sec_mode;
    
        BLE_GAP_CONN_SEC_MODE_SET_OPEN(&sec_mode);
    
        err_code = sd_ble_gap_device_name_set(&sec_mode,
                                              (const uint8_t *)DEVICE_NAME,
                                              strlen(DEVICE_NAME));
        APP_ERROR_CHECK(err_code);
    
        err_code = sd_ble_gap_appearance_set(BLE_APPEARANCE_HID_KEYBOARD);
        APP_ERROR_CHECK(err_code);
    
        memset(&gap_conn_params, 0, sizeof(gap_conn_params));
    
        gap_conn_params.min_conn_interval = MIN_CONN_INTERVAL;
        gap_conn_params.max_conn_interval = MAX_CONN_INTERVAL;
        gap_conn_params.slave_latency     = SLAVE_LATENCY;
        gap_conn_params.conn_sup_timeout  = CONN_SUP_TIMEOUT;
    
        err_code = sd_ble_gap_ppcp_set(&gap_conn_params);
        APP_ERROR_CHECK(err_code);
    }
    
    
    /**@brief Function for initializing the GATT module.
     */
    static void gatt_init(void)
    {
        ret_code_t err_code = nrf_ble_gatt_init(&m_gatt, NULL);
        APP_ERROR_CHECK(err_code);
    }
    
    
    /**@brief Function for handling Queued Write Module errors.
     *
     * @details A pointer to this function will be passed to each service which may need to inform the
     *          application about an error.
     *
     * @param[in]   nrf_error   Error code containing information about what went wrong.
     */
    static void nrf_qwr_error_handler(uint32_t nrf_error)
    {
        APP_ERROR_HANDLER(nrf_error);
    }
    
    
    /**@brief Function for initializing the Queued Write Module.
     */
    static void qwr_init(void)
    {
        ret_code_t         err_code;
        nrf_ble_qwr_init_t qwr_init_obj = {0};
    
        qwr_init_obj.error_handler = nrf_qwr_error_handler;
    
        err_code = nrf_ble_qwr_init(&m_qwr, &qwr_init_obj);
        APP_ERROR_CHECK(err_code);
    }
    
    
    /**@brief Function for initializing Device Information Service.
     */
    static void dis_init(void)
    {
        ret_code_t       err_code;
        ble_dis_init_t   dis_init_obj;
        ble_dis_pnp_id_t pnp_id;
    
        pnp_id.vendor_id_source = PNP_ID_VENDOR_ID_SOURCE;
        pnp_id.vendor_id        = PNP_ID_VENDOR_ID;
        pnp_id.product_id       = PNP_ID_PRODUCT_ID;
        pnp_id.product_version  = PNP_ID_PRODUCT_VERSION;
    
        memset(&dis_init_obj, 0, sizeof(dis_init_obj));
    
        ble_srv_ascii_to_utf8(&dis_init_obj.manufact_name_str, MANUFACTURER_NAME);
        dis_init_obj.p_pnp_id = &pnp_id;
    
        dis_init_obj.dis_char_rd_sec = SEC_JUST_WORKS;
    
        err_code = ble_dis_init(&dis_init_obj);
        APP_ERROR_CHECK(err_code);
    }
    
    
    /**@brief Function for initializing Battery Service.
     */
    static void bas_init(void)
    {
        ret_code_t     err_code;
        ble_bas_init_t bas_init_obj;
    
        memset(&bas_init_obj, 0, sizeof(bas_init_obj));
    
        bas_init_obj.evt_handler          = NULL;
        bas_init_obj.support_notification = true;
        bas_init_obj.p_report_ref         = NULL;
        bas_init_obj.initial_batt_level   = 100;
    
        bas_init_obj.bl_rd_sec        = SEC_JUST_WORKS;
        bas_init_obj.bl_cccd_wr_sec   = SEC_JUST_WORKS;
        bas_init_obj.bl_report_rd_sec = SEC_JUST_WORKS;
    
        err_code = ble_bas_init(&m_bas, &bas_init_obj);
        APP_ERROR_CHECK(err_code);
    }
    
    
    /**@brief Function for initializing HID Service.
     */
    static void hids_init(void)
    {
        ret_code_t                    err_code;
        ble_hids_init_t               hids_init_obj;
        ble_hids_inp_rep_init_t     * p_input_report;
        ble_hids_outp_rep_init_t    * p_output_report;
        ble_hids_feature_rep_init_t * p_feature_report;
        uint8_t                       hid_info_flags;
    
        static ble_hids_inp_rep_init_t     input_report_array[INPUT_REPORT_COUNT];
        static ble_hids_outp_rep_init_t    output_report_array[1];
        static ble_hids_feature_rep_init_t feature_report_array[1];
        static uint8_t                     report_map_data[] =
        {
            0x05, 0x01,       // Usage Page (Generic Desktop)
            0x09, 0x06,       // Usage (Keyboard)
            0xA1, 0x01,       // Collection (Application)
            0x85, 0x01,       //    Report ID 1
            0x05, 0x07,       //    Usage Page (Key Codes)
            0x19, 0xe0,       //       Usage Minimum (224)
            0x29, 0xe7,       //       Usage Maximum (231)
            0x15, 0x00,       //       Logical Minimum (0)
            0x25, 0x01,       //       Logical Maximum (1)
            0x75, 0x01,       //       Report Size (1)
            0x95, 0x08,       //       Report Count (8)
            0x81, 0x02,       //       Input (Data, Variable, Absolute)
            0x95, 0x01,       //       Report Count (1)
            0x75, 0x08,       //       Report Size (8)
            0x81, 0x01,       //       Input (Constant) reserved byte(1)
            0x95, 0x05,       //       Report Count (5)
            0x75, 0x01,       //       Report Size (1)
            0x05, 0x08,       //    Usage Page (Page# for LEDs)
            0x19, 0x01,       //       Usage Minimum (1)
            0x29, 0x05,       //       Usage Maximum (5)
            0x91, 0x02,       //       Output (Data, Variable, Absolute), Led report
            0x95, 0x01,       //       Report Count (1)
            0x75, 0x03,       //       Report Size (3)
            0x91, 0x01,       //       Output (Data, Variable, Absolute), Led report padding
            0x95, 0x06,       //       Report Count (6)
            0x75, 0x08,       //       Report Size (8)
            0x15, 0x00,       //       Logical Minimum (0)
            0x25, 0x65,       //       Logical Maximum (101)
            0x05, 0x07,       //    Usage Page (Key codes)
            0x19, 0x00,       //       Usage Minimum (0)
            0x29, 0x65,       //       Usage Maximum (101)
            0x81, 0x00,       //       Input (Data, Array) Key array(6 bytes)
            0x09, 0x05,       //    Usage (Vendor Defined)
            0x15, 0x00,       //       Logical Minimum (0)
            0x26, 0xFF, 0x00, //       Logical Maximum (255)
            0x75, 0x08,       //       Report Size (8 bit)
            0x95, 0x02,       //       Report Count (2)
            0xB1, 0x02,       //       Feature (Data, Variable, Absolute)
            0xC0,             // End Collection (Application)
    
            0x05, 0x0D,       // USAGE_PAGE (Digitizer) 
            0x09, 0x01,       // USAGE (Digitizer)
            0xA1, 0x01,       // Collection (Application)
            0x85, 0x02,       //    REPORT_ID 2
            0x09, 0x22,       //    USAGE (Finger)
            0xA1, 0x02,       //    Collection (Logical)
            0x09, 0x42,       //	   USAGE (Tip Switch)
            0x15, 0x00,       //	   LOGICAL_MINIMUM (0)
            0x25, 0x01,       //       LOGICAL_MAXIMUM (1)
            0x75, 0x01,       //	   REPORT_SIZE (1)
            0x95, 0x01,       //	   REPORT_COUNT (1)
            0x81, 0x02,       //       INPUT (Data,Var,Abs)
            0x09, 0x32,       //       USAGE (In Range)
            0x81, 0x02,       //       INPUT (Data,Var,Abs)
            0x95, 0x06,       //       REPORT_COUNT (6)
            0x81, 0x03,       //       INPUT (Cnst,Ary,Abs)
            0x05, 0x01,       //       USAGE_PAGE (Generic Desktop)
            0x26, 0xE8, 0x03, //       LOGICAL_MAXIMUM (0x03E8 = 1000)
            0x75, 0x10,       //       REPORT_SIZE (16)
            0x95, 0x01,       //       REPORT_COUNT (1)
            0x55, 0x00,       //       UNIT_EXPONENT (0)
            0x65, 0x00,       //       UNIT(Inch, EngLinear)
            0x09, 0x30,       //       USAGE (X)
            0x35, 0x00,       //       PHYSICAL_MINIMUM (0)
            0x46, 0xE8, 0x03, //       PHYSICAL_MAXIMUM (0x03E8 = 1000)
            0x81, 0x02,       //       INPUT (Data,Var,Abs)
            0x09, 0x31,       //       USAGE (Y)
            0x46, 0xE8, 0x03, //       PHYSICAL_MAXIMUM (0x03E8 = 1000)
            0x81, 0x02,       //       INPUT (Data,Var,Abs)
            0xC0,             //    END_COLLECTION
            0x05, 0x0D,       //    USAGE_PAGE (Digitizer)
            0x09, 0x48,       //    USAGE (Width)
            0x09, 0x49,       //    USAGE (Height)
            0x95, 0x02,       //    REPORT_COUNT (2)
            0x81, 0x02,       //    INPUT (Data,Var,Abs)
            0xC0             // END_COLLECTION
        };
    
        memset((void *)input_report_array, 0, sizeof(ble_hids_inp_rep_init_t));
        memset((void *)output_report_array, 0, sizeof(ble_hids_outp_rep_init_t));
        memset((void *)feature_report_array, 0, sizeof(ble_hids_feature_rep_init_t));
    
        // Initialize Keyboard HID Service
        p_input_report                      = &input_report_array[INPUT_REPORT_KEYS_INDEX];
        p_input_report->max_len             = INPUT_REPORT_KEYS_MAX_LEN;
        p_input_report->rep_ref.report_id   = INPUT_REP_REF_KEYBOARD_ID;
        p_input_report->rep_ref.report_type = BLE_HIDS_REP_TYPE_INPUT;
    
        p_input_report->sec.cccd_wr = SEC_JUST_WORKS;
        p_input_report->sec.wr      = SEC_JUST_WORKS;
        p_input_report->sec.rd      = SEC_JUST_WORKS;
    
        p_output_report                      = &output_report_array[OUTPUT_REPORT_INDEX];
        p_output_report->max_len             = OUTPUT_REPORT_MAX_LEN;
        p_output_report->rep_ref.report_id   = OUTPUT_REP_REF_ID;
        p_output_report->rep_ref.report_type = BLE_HIDS_REP_TYPE_OUTPUT;
    
        p_output_report->sec.wr = SEC_JUST_WORKS;
        p_output_report->sec.rd = SEC_JUST_WORKS;
    
        p_feature_report                      = &feature_report_array[FEATURE_REPORT_INDEX];
        p_feature_report->max_len             = FEATURE_REPORT_MAX_LEN;
        p_feature_report->rep_ref.report_id   = FEATURE_REP_REF_ID;
        p_feature_report->rep_ref.report_type = BLE_HIDS_REP_TYPE_FEATURE;
    
        p_feature_report->sec.rd              = SEC_JUST_WORKS;
        p_feature_report->sec.wr              = SEC_JUST_WORKS;
    
        // Initialize Digitizer HID Service
    #ifdef ENABLE_DIGITIZER    
        p_input_report                      = &input_report_array[INPUT_REPORT_DIG_INDEX];
        p_input_report->max_len             = INPUT_REPORT_DIG_MAX_LEN;
        p_input_report->rep_ref.report_id   = INPUT_REP_REF_DIGITIZER_ID;
        p_input_report->rep_ref.report_type = BLE_HIDS_REP_TYPE_INPUT;
    
        p_input_report->sec.cccd_wr = SEC_JUST_WORKS;
        p_input_report->sec.wr      = SEC_JUST_WORKS;
        p_input_report->sec.rd      = SEC_JUST_WORKS;
    #endif
    
        hid_info_flags = HID_INFO_FLAG_REMOTE_WAKE_MSK | HID_INFO_FLAG_NORMALLY_CONNECTABLE_MSK;
    
        memset(&hids_init_obj, 0, sizeof(hids_init_obj));
    
        hids_init_obj.evt_handler                    = on_hids_evt;
        hids_init_obj.error_handler                  = service_error_handler;
        hids_init_obj.is_kb                          = true;
        hids_init_obj.is_mouse                       = false;
        hids_init_obj.inp_rep_count                  = INPUT_REPORT_COUNT;
        hids_init_obj.p_inp_rep_array                = input_report_array;
        hids_init_obj.outp_rep_count                 = 1;
        hids_init_obj.p_outp_rep_array               = output_report_array;
        hids_init_obj.feature_rep_count              = 1;
        hids_init_obj.p_feature_rep_array            = feature_report_array;
        hids_init_obj.rep_map.data_len               = sizeof(report_map_data);
        hids_init_obj.rep_map.p_data                 = report_map_data;
        hids_init_obj.hid_information.bcd_hid        = BASE_USB_HID_SPEC_VERSION;
        hids_init_obj.hid_information.b_country_code = 0;
        hids_init_obj.hid_information.flags          = hid_info_flags;
        hids_init_obj.included_services_count        = 0;
        hids_init_obj.p_included_services_array      = NULL;
    
        hids_init_obj.rep_map.rd_sec         = SEC_JUST_WORKS;
        hids_init_obj.hid_information.rd_sec = SEC_JUST_WORKS;
    
        hids_init_obj.boot_kb_inp_rep_sec.cccd_wr = SEC_JUST_WORKS;
        hids_init_obj.boot_kb_inp_rep_sec.rd      = SEC_JUST_WORKS;
    
        hids_init_obj.boot_kb_outp_rep_sec.rd = SEC_JUST_WORKS;
        hids_init_obj.boot_kb_outp_rep_sec.wr = SEC_JUST_WORKS;
    
        hids_init_obj.protocol_mode_rd_sec = SEC_JUST_WORKS;
        hids_init_obj.protocol_mode_wr_sec = SEC_JUST_WORKS;
        hids_init_obj.ctrl_point_wr_sec    = SEC_JUST_WORKS;
    
        err_code = ble_hids_init(&m_hids, &hids_init_obj);
        APP_ERROR_CHECK(err_code);
    }
    
    
    /**@brief Function for initializing services that will be used by the application.
     */
    static void services_init(void)
    {
        qwr_init();
        dis_init();
        bas_init();
        hids_init();
    }
    
    
    /**@brief Function for initializing the battery sensor simulator.
     */
    static void sensor_simulator_init(void)
    {
        m_battery_sim_cfg.min          = MIN_BATTERY_LEVEL;
        m_battery_sim_cfg.max          = MAX_BATTERY_LEVEL;
        m_battery_sim_cfg.incr         = BATTERY_LEVEL_INCREMENT;
        m_battery_sim_cfg.start_at_max = true;
    
        sensorsim_init(&m_battery_sim_state, &m_battery_sim_cfg);
    }
    
    
    /**@brief Function for handling a Connection Parameters error.
     *
     * @param[in]   nrf_error   Error code containing information about what went wrong.
     */
    static void conn_params_error_handler(uint32_t nrf_error)
    {
        APP_ERROR_HANDLER(nrf_error);
    }
    
    
    /**@brief Function for initializing the Connection Parameters module.
     */
    static void conn_params_init(void)
    {
        ret_code_t             err_code;
        ble_conn_params_init_t cp_init;
    
        memset(&cp_init, 0, sizeof(cp_init));
    
        cp_init.p_conn_params                  = NULL;
        cp_init.first_conn_params_update_delay = FIRST_CONN_PARAMS_UPDATE_DELAY;
        cp_init.next_conn_params_update_delay  = NEXT_CONN_PARAMS_UPDATE_DELAY;
        cp_init.max_conn_params_update_count   = MAX_CONN_PARAMS_UPDATE_COUNT;
        cp_init.start_on_notify_cccd_handle    = BLE_GATT_HANDLE_INVALID;
        cp_init.disconnect_on_fail             = false;
        cp_init.evt_handler                    = NULL;
        cp_init.error_handler                  = conn_params_error_handler;
    
        err_code = ble_conn_params_init(&cp_init);
        APP_ERROR_CHECK(err_code);
    }
    
    
    /**@brief Function for starting timers.
     */
    static void timers_start(void)
    {
        ret_code_t err_code;
    
        err_code = app_timer_start(m_battery_timer_id, BATTERY_LEVEL_MEAS_INTERVAL, NULL);
        APP_ERROR_CHECK(err_code);
    }
    
    
    /**@brief   Function for transmitting a key scan Press & Release Notification.
     *
     * @warning This handler is an example only. You need to analyze how you wish to send the key
     *          release.
     *
     * @param[in]  p_instance     Identifies the service for which Key Notifications are requested.
     * @param[in]  p_key_pattern  Pointer to key pattern.
     * @param[in]  pattern_len    Length of key pattern. 0 < pattern_len < 7.
     * @param[in]  pattern_offset Offset applied to Key Pattern for transmission.
     * @param[out] actual_len     Provides actual length of Key Pattern transmitted, making buffering of
     *                            rest possible if needed.
     * @return     NRF_SUCCESS on success, NRF_ERROR_RESOURCES in case transmission could not be
     *             completed due to lack of transmission buffer or other error codes indicating reason
     *             for failure.
     *
     * @note       In case of NRF_ERROR_RESOURCES, remaining pattern that could not be transmitted
     *             can be enqueued \ref buffer_enqueue function.
     *             In case a pattern of 'cofFEe' is the p_key_pattern, with pattern_len as 6 and
     *             pattern_offset as 0, the notifications as observed on the peer side would be
     *             1>    'c', 'o', 'f', 'F', 'E', 'e'
     *             2>    -  , 'o', 'f', 'F', 'E', 'e'
     *             3>    -  ,   -, 'f', 'F', 'E', 'e'
     *             4>    -  ,   -,   -, 'F', 'E', 'e'
     *             5>    -  ,   -,   -,   -, 'E', 'e'
     *             6>    -  ,   -,   -,   -,   -, 'e'
     *             7>    -  ,   -,   -,   -,   -,  -
     *             Here, '-' refers to release, 'c' refers to the key character being transmitted.
     *             Therefore 7 notifications will be sent.
     *             In case an offset of 4 was provided, the pattern notifications sent will be from 5-7
     *             will be transmitted.
     */
    static uint32_t send_key_scan_press_release(ble_hids_t * p_hids,
                                                uint8_t    * p_key_pattern,
                                                uint16_t     pattern_len,
                                                uint16_t     pattern_offset,
                                                uint16_t   * p_actual_len)
    {
        ret_code_t err_code;
        uint16_t offset;
        uint16_t data_len;
        uint8_t  data[INPUT_REPORT_KEYS_MAX_LEN];
    
        // HID Report Descriptor enumerates an array of size 6, the pattern hence shall not be any
        // longer than this.
        STATIC_ASSERT((INPUT_REPORT_KEYS_MAX_LEN - 2) == 6);
    
        ASSERT(pattern_len <= (INPUT_REPORT_KEYS_MAX_LEN - 2));
    
        offset   = pattern_offset;
        data_len = pattern_len;
    
        do
        {
            // Reset the data buffer.
            memset(data, 0, sizeof(data));
    
            // Copy the scan code.
            memcpy(data + SCAN_CODE_POS + offset, p_key_pattern + offset, data_len - offset);
    
            if (bsp_button_is_pressed(SHIFT_BUTTON_ID))
            {
                data[MODIFIER_KEY_POS] |= SHIFT_KEY_CODE;
            }
    
            if (!m_in_boot_mode)
            {
                err_code = ble_hids_inp_rep_send(p_hids,
                                                 INPUT_REPORT_KEYS_INDEX,
                                                 INPUT_REPORT_KEYS_MAX_LEN,
                                                 data,
                                                 m_conn_handle);
            }
            else
            {
                err_code = ble_hids_boot_kb_inp_rep_send(p_hids,
                                                         INPUT_REPORT_KEYS_MAX_LEN,
                                                         data,
                                                         m_conn_handle);
            }
    
            if (err_code != NRF_SUCCESS)
            {
                break;
            }
    
            offset++;
        }
        while (offset <= data_len);
    
        *p_actual_len = offset;
    
        return err_code;
    }
    
    
    /**@brief   Function for initializing the buffer queue used to key events that could not be
     *          transmitted
     *
     * @warning This handler is an example only. You need to analyze how you wish to buffer or buffer at
     *          all.
     *
     * @note    In case of HID keyboard, a temporary buffering could be employed to handle scenarios
     *          where encryption is not yet enabled or there was a momentary link loss or there were no
     *          Transmit buffers.
     */
    static void buffer_init(void)
    {
        uint32_t buffer_count;
    
        BUFFER_LIST_INIT();
    
        for (buffer_count = 0; buffer_count < MAX_BUFFER_ENTRIES; buffer_count++)
        {
            BUFFER_ELEMENT_INIT(buffer_count);
        }
    }
    
    
    /**@brief Function for enqueuing key scan patterns that could not be transmitted either completely
     *        or partially.
     *
     * @warning This handler is an example only. You need to analyze how you wish to send the key
     *          release.
     *
     * @param[in]  p_hids         Identifies the service for which Key Notifications are buffered.
     * @param[in]  p_key_pattern  Pointer to key pattern.
     * @param[in]  pattern_len    Length of key pattern.
     * @param[in]  offset         Offset applied to Key Pattern when requesting a transmission on
     *                            dequeue, @ref buffer_dequeue.
     * @return     NRF_SUCCESS on success, else an error code indicating reason for failure.
     */
    static uint32_t buffer_enqueue(ble_hids_t * p_hids,
                                   uint8_t    * p_key_pattern,
                                   uint16_t     pattern_len,
                                   uint16_t     offset)
    {
        buffer_entry_t * element;
        uint32_t         err_code = NRF_SUCCESS;
    
        if (BUFFER_LIST_FULL())
        {
            // Element cannot be buffered.
            err_code = NRF_ERROR_NO_MEM;
        }
        else
        {
            // Make entry of buffer element and copy data.
            element              = &buffer_list.buffer[(buffer_list.wp)];
            element->p_instance  = p_hids;
            element->p_data      = p_key_pattern;
            element->data_offset = offset;
            element->data_len    = pattern_len;
    
            buffer_list.count++;
            buffer_list.wp++;
    
            if (buffer_list.wp == MAX_BUFFER_ENTRIES)
            {
                buffer_list.wp = 0;
            }
        }
    
        return err_code;
    }
    
    
    /**@brief   Function to dequeue key scan patterns that could not be transmitted either completely of
     *          partially.
     *
     * @warning This handler is an example only. You need to analyze how you wish to send the key
     *          release.
     *
     * @param[in]  tx_flag   Indicative of whether the dequeue should result in transmission or not.
     * @note       A typical example when all keys are dequeued with transmission is when link is
     *             disconnected.
     *
     * @return     NRF_SUCCESS on success, else an error code indicating reason for failure.
     */
    static uint32_t buffer_dequeue(bool tx_flag)
    {
        buffer_entry_t * p_element;
        uint32_t         err_code = NRF_SUCCESS;
        uint16_t         actual_len;
    
        if (BUFFER_LIST_EMPTY())
        {
            err_code = NRF_ERROR_NOT_FOUND;
        }
        else
        {
            bool remove_element = true;
    
            p_element = &buffer_list.buffer[(buffer_list.rp)];
    
            if (tx_flag)
            {
                err_code = send_key_scan_press_release(p_element->p_instance,
                                                       p_element->p_data,
                                                       p_element->data_len,
                                                       p_element->data_offset,
                                                       &actual_len);
                // An additional notification is needed for release of all keys, therefore check
                // is for actual_len <= element->data_len and not actual_len < element->data_len
                if ((err_code == NRF_ERROR_RESOURCES) && (actual_len <= p_element->data_len))
                {
                    // Transmission could not be completed, do not remove the entry, adjust next data to
                    // be transmitted
                    p_element->data_offset = actual_len;
                    remove_element         = false;
                }
            }
    
            if (remove_element)
            {
                BUFFER_ELEMENT_INIT(buffer_list.rp);
    
                buffer_list.rp++;
                buffer_list.count--;
    
                if (buffer_list.rp == MAX_BUFFER_ENTRIES)
                {
                    buffer_list.rp = 0;
                }
            }
        }
    
        return err_code;
    }
    
    
    /**@brief Function for sending sample key presses to the peer.
     *
     * @param[in]   key_pattern_len   Pattern length.
     * @param[in]   p_key_pattern     Pattern to be sent.
     */
    static void keys_send(uint8_t key_pattern_len, uint8_t * p_key_pattern)
    {
        ret_code_t err_code;
        uint16_t actual_len;
    
        err_code = send_key_scan_press_release(&m_hids,
                                               p_key_pattern,
                                               key_pattern_len,
                                               0,
                                               &actual_len);
        // An additional notification is needed for release of all keys, therefore check
        // is for actual_len <= key_pattern_len and not actual_len < key_pattern_len.
        if ((err_code == NRF_ERROR_RESOURCES) && (actual_len <= key_pattern_len))
        {
            // Buffer enqueue routine return value is not intentionally checked.
            // Rationale: Its better to have a a few keys missing than have a system
            // reset. Recommendation is to work out most optimal value for
            // MAX_BUFFER_ENTRIES to minimize chances of buffer queue full condition
            UNUSED_VARIABLE(buffer_enqueue(&m_hids, p_key_pattern, key_pattern_len, actual_len));
        }
    
    
        if ((err_code != NRF_SUCCESS) &&
            (err_code != NRF_ERROR_INVALID_STATE) &&
            (err_code != NRF_ERROR_RESOURCES) &&
            (err_code != NRF_ERROR_BUSY) &&
            (err_code != BLE_ERROR_GATTS_SYS_ATTR_MISSING)
           )
        {
            APP_ERROR_HANDLER(err_code);
        }
    }
    
    
    /**@brief Function for handling the HID Report Characteristic Write event.
     *
     * @param[in]   p_evt   HID service event.
     */
    static void on_hid_rep_char_write(ble_hids_evt_t * p_evt)
    {
        if (p_evt->params.char_write.char_id.rep_type == BLE_HIDS_REP_TYPE_OUTPUT)
        {
            ret_code_t err_code;
            uint8_t  report_val;
            uint8_t  report_index = p_evt->params.char_write.char_id.rep_index;
    
            if (report_index == OUTPUT_REPORT_INDEX)
            {
                // This code assumes that the output report is one byte long. Hence the following
                // static assert is made.
                STATIC_ASSERT(OUTPUT_REPORT_MAX_LEN == 1);
    
                err_code = ble_hids_outp_rep_get(&m_hids,
                                                 report_index,
                                                 OUTPUT_REPORT_MAX_LEN,
                                                 0,
                                                 m_conn_handle,
                                                 &report_val);
                APP_ERROR_CHECK(err_code);
    
                if (!m_caps_on && ((report_val & OUTPUT_REPORT_BIT_MASK_CAPS_LOCK) != 0))
                {
                    // Caps Lock is turned On.
                    NRF_LOG_INFO("Caps Lock is turned On!");
                    err_code = bsp_indication_set(BSP_INDICATE_ALERT_3);
                    APP_ERROR_CHECK(err_code);
    
                    keys_send(sizeof(m_caps_on_key_scan_str), m_caps_on_key_scan_str);
                    m_caps_on = true;
                }
                else if (m_caps_on && ((report_val & OUTPUT_REPORT_BIT_MASK_CAPS_LOCK) == 0))
                {
                    // Caps Lock is turned Off .
                    NRF_LOG_INFO("Caps Lock is turned Off!");
                    err_code = bsp_indication_set(BSP_INDICATE_ALERT_OFF);
                    APP_ERROR_CHECK(err_code);
    
                    keys_send(sizeof(m_caps_off_key_scan_str), m_caps_off_key_scan_str);
                    m_caps_on = false;
                }
                else
                {
                    // The report received is not supported by this application. Do nothing.
                }
            }
        }
    }
    
    
    /**@brief Function for putting the chip into sleep mode.
     *
     * @note This function will not return.
     */
    static void sleep_mode_enter(void)
    {
        ret_code_t err_code;
    
        err_code = bsp_indication_set(BSP_INDICATE_IDLE);
        APP_ERROR_CHECK(err_code);
    
        // Prepare wakeup buttons.
        err_code = bsp_btn_ble_sleep_mode_prepare();
        APP_ERROR_CHECK(err_code);
    
        // Go to system-off mode (this function will not return; wakeup will cause a reset).
        err_code = sd_power_system_off();
        APP_ERROR_CHECK(err_code);
    }
    
    
    /**@brief Function for handling HID events.
     *
     * @details This function will be called for all HID events which are passed to the application.
     *
     * @param[in]   p_hids  HID service structure.
     * @param[in]   p_evt   Event received from the HID service.
     */
    static void on_hids_evt(ble_hids_t * p_hids, ble_hids_evt_t * p_evt)
    {
        switch (p_evt->evt_type)
        {
            case BLE_HIDS_EVT_BOOT_MODE_ENTERED:
                m_in_boot_mode = true;
                break;
    
            case BLE_HIDS_EVT_REPORT_MODE_ENTERED:
                m_in_boot_mode = false;
                break;
    
            case BLE_HIDS_EVT_REP_CHAR_WRITE:
                on_hid_rep_char_write(p_evt);
                break;
    
            case BLE_HIDS_EVT_NOTIF_ENABLED:
                break;
    
            default:
                // No implementation needed.
                break;
        }
    }
    
    
    /**@brief Function for handling advertising events.
     *
     * @details This function will be called for advertising events which are passed to the application.
     *
     * @param[in] ble_adv_evt  Advertising event.
     */
    static void on_adv_evt(ble_adv_evt_t ble_adv_evt)
    {
        ret_code_t err_code;
    
        switch (ble_adv_evt)
        {
            case BLE_ADV_EVT_DIRECTED_HIGH_DUTY:
                NRF_LOG_INFO("High Duty Directed advertising.");
                err_code = bsp_indication_set(BSP_INDICATE_ADVERTISING_DIRECTED);
                APP_ERROR_CHECK(err_code);
                break;
    
            case BLE_ADV_EVT_DIRECTED:
                NRF_LOG_INFO("Directed advertising.");
                err_code = bsp_indication_set(BSP_INDICATE_ADVERTISING_DIRECTED);
                APP_ERROR_CHECK(err_code);
                break;
    
            case BLE_ADV_EVT_FAST:
                NRF_LOG_INFO("Fast advertising.");
                err_code = bsp_indication_set(BSP_INDICATE_ADVERTISING);
                APP_ERROR_CHECK(err_code);
                break;
    
            case BLE_ADV_EVT_SLOW:
                NRF_LOG_INFO("Slow advertising.");
                err_code = bsp_indication_set(BSP_INDICATE_ADVERTISING_SLOW);
                APP_ERROR_CHECK(err_code);
                break;
    
            case BLE_ADV_EVT_FAST_WHITELIST:
                NRF_LOG_INFO("Fast advertising with whitelist.");
                err_code = bsp_indication_set(BSP_INDICATE_ADVERTISING_WHITELIST);
                APP_ERROR_CHECK(err_code);
                break;
    
            case BLE_ADV_EVT_SLOW_WHITELIST:
                NRF_LOG_INFO("Slow advertising with whitelist.");
                err_code = bsp_indication_set(BSP_INDICATE_ADVERTISING_WHITELIST);
                APP_ERROR_CHECK(err_code);
                break;
    
            case BLE_ADV_EVT_IDLE:
                sleep_mode_enter();
                break;
    
            case BLE_ADV_EVT_WHITELIST_REQUEST:
            {
                ble_gap_addr_t whitelist_addrs[BLE_GAP_WHITELIST_ADDR_MAX_COUNT];
                ble_gap_irk_t  whitelist_irks[BLE_GAP_WHITELIST_ADDR_MAX_COUNT];
                uint32_t       addr_cnt = BLE_GAP_WHITELIST_ADDR_MAX_COUNT;
                uint32_t       irk_cnt  = BLE_GAP_WHITELIST_ADDR_MAX_COUNT;
    
                err_code = pm_whitelist_get(whitelist_addrs, &addr_cnt,
                                            whitelist_irks,  &irk_cnt);
                APP_ERROR_CHECK(err_code);
                NRF_LOG_DEBUG("pm_whitelist_get returns %d addr in whitelist and %d irk whitelist",
                              addr_cnt, irk_cnt);
    
                // Set the correct identities list (no excluding peers with no Central Address Resolution).
                identities_set(PM_PEER_ID_LIST_SKIP_NO_IRK);
    
                // Apply the whitelist.
                err_code = ble_advertising_whitelist_reply(&m_advertising,
                                                           whitelist_addrs,
                                                           addr_cnt,
                                                           whitelist_irks,
                                                           irk_cnt);
                APP_ERROR_CHECK(err_code);
            } break; //BLE_ADV_EVT_WHITELIST_REQUEST
    
            case BLE_ADV_EVT_PEER_ADDR_REQUEST:
            {
                pm_peer_data_bonding_t peer_bonding_data;
    
                // Only Give peer address if we have a handle to the bonded peer.
                if (m_peer_id != PM_PEER_ID_INVALID)
                {
                    err_code = pm_peer_data_bonding_load(m_peer_id, &peer_bonding_data);
                    if (err_code != NRF_ERROR_NOT_FOUND)
                    {
                        APP_ERROR_CHECK(err_code);
    
                        // Manipulate identities to exclude peers with no Central Address Resolution.
                        identities_set(PM_PEER_ID_LIST_SKIP_ALL);
    
                        ble_gap_addr_t * p_peer_addr = &(peer_bonding_data.peer_ble_id.id_addr_info);
                        err_code = ble_advertising_peer_addr_reply(&m_advertising, p_peer_addr);
                        APP_ERROR_CHECK(err_code);
                    }
                }
            } break; //BLE_ADV_EVT_PEER_ADDR_REQUEST
    
            default:
                break;
        }
    }
    
    
    /**@brief Function for handling BLE events.
     *
     * @param[in]   p_ble_evt   Bluetooth stack event.
     * @param[in]   p_context   Unused.
     */
    static void ble_evt_handler(ble_evt_t const * p_ble_evt, void * p_context)
    {
        ret_code_t err_code;
    
        switch (p_ble_evt->header.evt_id)
        {
            case BLE_GAP_EVT_CONNECTED:
                NRF_LOG_INFO("Connected");
                err_code = bsp_indication_set(BSP_INDICATE_CONNECTED);
                APP_ERROR_CHECK(err_code);
                m_conn_handle = p_ble_evt->evt.gap_evt.conn_handle;
                err_code = nrf_ble_qwr_conn_handle_assign(&m_qwr, m_conn_handle);
                APP_ERROR_CHECK(err_code);
                break;
    
            case BLE_GAP_EVT_DISCONNECTED:
                NRF_LOG_INFO("Disconnected");
                // Dequeue all keys without transmission.
                (void) buffer_dequeue(false);
    
                m_conn_handle = BLE_CONN_HANDLE_INVALID;
    
                // Reset m_caps_on variable. Upon reconnect, the HID host will re-send the Output
                // report containing the Caps lock state.
                m_caps_on = false;
                // disabling alert 3. signal - used for capslock ON
                err_code = bsp_indication_set(BSP_INDICATE_ALERT_OFF);
                APP_ERROR_CHECK(err_code);
    
                break; // BLE_GAP_EVT_DISCONNECTED
    
            case BLE_GAP_EVT_PHY_UPDATE_REQUEST:
            {
                NRF_LOG_DEBUG("PHY update request.");
                ble_gap_phys_t const phys =
                {
                    .rx_phys = BLE_GAP_PHY_AUTO,
                    .tx_phys = BLE_GAP_PHY_AUTO,
                };
                err_code = sd_ble_gap_phy_update(p_ble_evt->evt.gap_evt.conn_handle, &phys);
                APP_ERROR_CHECK(err_code);
            } break;
    
            case BLE_GATTS_EVT_HVN_TX_COMPLETE:
                // Send next key event
                (void) buffer_dequeue(true);
                break;
    
            case BLE_GATTC_EVT_TIMEOUT:
                // Disconnect on GATT Client timeout event.
                NRF_LOG_DEBUG("GATT Client Timeout.");
                err_code = sd_ble_gap_disconnect(p_ble_evt->evt.gattc_evt.conn_handle,
                                                 BLE_HCI_REMOTE_USER_TERMINATED_CONNECTION);
                APP_ERROR_CHECK(err_code);
                break;
    
            case BLE_GATTS_EVT_TIMEOUT:
                // Disconnect on GATT Server timeout event.
                NRF_LOG_DEBUG("GATT Server Timeout.");
                err_code = sd_ble_gap_disconnect(p_ble_evt->evt.gatts_evt.conn_handle,
                                                 BLE_HCI_REMOTE_USER_TERMINATED_CONNECTION);
                APP_ERROR_CHECK(err_code);
                break;
    
            default:
                // No implementation needed.
                break;
        }
    }
    
    
    /**@brief Function for initializing the BLE stack.
     *
     * @details Initializes the SoftDevice and the BLE event interrupt.
     */
    static void ble_stack_init(void)
    {
        ret_code_t err_code;
    
        err_code = nrf_sdh_enable_request();
        APP_ERROR_CHECK(err_code);
    
        // Configure the BLE stack using the default settings.
        // Fetch the start address of the application RAM.
        uint32_t ram_start = 0;
        err_code = nrf_sdh_ble_default_cfg_set(APP_BLE_CONN_CFG_TAG, &ram_start);
        APP_ERROR_CHECK(err_code);
    
        // Enable BLE stack.
        err_code = nrf_sdh_ble_enable(&ram_start);
        APP_ERROR_CHECK(err_code);
    
        // Register a handler for BLE events.
        NRF_SDH_BLE_OBSERVER(m_ble_observer, APP_BLE_OBSERVER_PRIO, ble_evt_handler, NULL);
    }
    
    
    /**@brief Function for the Event Scheduler initialization.
     */
    static void scheduler_init(void)
    {
        APP_SCHED_INIT(SCHED_MAX_EVENT_DATA_SIZE, SCHED_QUEUE_SIZE);
    }
    
    
    /**@brief Function for handling events from the BSP module.
     *
     * @param[in]   event   Event generated by button press.
     */
    static void bsp_event_handler(bsp_event_t event)
    {
        uint32_t         err_code;
        static uint8_t * p_key = m_sample_key_press_scan_str;
        static uint8_t   size  = 0;
    
        switch (event)
        {
            case BSP_EVENT_SLEEP:
                sleep_mode_enter();
                break;
    
            case BSP_EVENT_DISCONNECT:
                err_code = sd_ble_gap_disconnect(m_conn_handle,
                                                 BLE_HCI_REMOTE_USER_TERMINATED_CONNECTION);
                if (err_code != NRF_ERROR_INVALID_STATE)
                {
                    APP_ERROR_CHECK(err_code);
                }
                break;
    
            case BSP_EVENT_WHITELIST_OFF:
                if (m_conn_handle == BLE_CONN_HANDLE_INVALID)
                {
                    err_code = ble_advertising_restart_without_whitelist(&m_advertising);
                    if (err_code != NRF_ERROR_INVALID_STATE)
                    {
                        APP_ERROR_CHECK(err_code);
                    }
                }
                break;
    
            case BSP_EVENT_KEY_0:
                if (m_conn_handle != BLE_CONN_HANDLE_INVALID)
                {
                    keys_send(1, p_key);
                    p_key++;
                    size++;
                    if (size == MAX_KEYS_IN_ONE_REPORT)
                    {
                        p_key = m_sample_key_press_scan_str;
                        size  = 0;
                    }
                }
                break;
    
            default:
                break;
        }
    }
    
    
    /**@brief Function for the Peer Manager initialization.
     */
    static void peer_manager_init(void)
    {
        ble_gap_sec_params_t sec_param;
        ret_code_t           err_code;
    
        err_code = pm_init();
        APP_ERROR_CHECK(err_code);
    
        memset(&sec_param, 0, sizeof(ble_gap_sec_params_t));
    
        // Security parameters to be used for all security procedures.
        sec_param.bond           = SEC_PARAM_BOND;
        sec_param.mitm           = SEC_PARAM_MITM;
        sec_param.lesc           = SEC_PARAM_LESC;
        sec_param.keypress       = SEC_PARAM_KEYPRESS;
        sec_param.io_caps        = SEC_PARAM_IO_CAPABILITIES;
        sec_param.oob            = SEC_PARAM_OOB;
        sec_param.min_key_size   = SEC_PARAM_MIN_KEY_SIZE;
        sec_param.max_key_size   = SEC_PARAM_MAX_KEY_SIZE;
        sec_param.kdist_own.enc  = 1;
        sec_param.kdist_own.id   = 1;
        sec_param.kdist_peer.enc = 1;
        sec_param.kdist_peer.id  = 1;
    
        err_code = pm_sec_params_set(&sec_param);
        APP_ERROR_CHECK(err_code);
    
        err_code = pm_register(pm_evt_handler);
        APP_ERROR_CHECK(err_code);
    }
    
    
    /**@brief Function for initializing the Advertising functionality.
     */
    static void advertising_init(void)
    {
        uint32_t               err_code;
        uint8_t                adv_flags;
        ble_advertising_init_t init;
    
        memset(&init, 0, sizeof(init));
    
        adv_flags                            = BLE_GAP_ADV_FLAGS_LE_ONLY_GENERAL_DISC_MODE;
        init.advdata.name_type               = BLE_ADVDATA_FULL_NAME;
        init.advdata.include_appearance      = true;
        init.advdata.flags                   = adv_flags;
        init.advdata.uuids_complete.uuid_cnt = sizeof(m_adv_uuids) / sizeof(m_adv_uuids[0]);
        init.advdata.uuids_complete.p_uuids  = m_adv_uuids;
    
        init.config.ble_adv_whitelist_enabled          = true;
        init.config.ble_adv_directed_high_duty_enabled = true;
        init.config.ble_adv_directed_enabled           = false;
        init.config.ble_adv_directed_interval          = 0;
        init.config.ble_adv_directed_timeout           = 0;
        init.config.ble_adv_fast_enabled               = true;
        init.config.ble_adv_fast_interval              = APP_ADV_FAST_INTERVAL;
        init.config.ble_adv_fast_timeout               = APP_ADV_FAST_DURATION;
        init.config.ble_adv_slow_enabled               = true;
        init.config.ble_adv_slow_interval              = APP_ADV_SLOW_INTERVAL;
        init.config.ble_adv_slow_timeout               = APP_ADV_SLOW_DURATION;
    
        init.evt_handler   = on_adv_evt;
        init.error_handler = ble_advertising_error_handler;
    
        err_code = ble_advertising_init(&m_advertising, &init);
        APP_ERROR_CHECK(err_code);
    
        ble_advertising_conn_cfg_tag_set(&m_advertising, APP_BLE_CONN_CFG_TAG);
    }
    
    
    /**@brief Function for initializing buttons and leds.
     *
     * @param[out] p_erase_bonds  Will be true if the clear bonding button was pressed to wake the application up.
     */
    static void buttons_leds_init(bool * p_erase_bonds)
    {
        ret_code_t err_code;
        bsp_event_t startup_event;
    
        err_code = bsp_init(BSP_INIT_LEDS | BSP_INIT_BUTTONS, bsp_event_handler);
        APP_ERROR_CHECK(err_code);
    
        err_code = bsp_btn_ble_init(NULL, &startup_event);
        APP_ERROR_CHECK(err_code);
    
        *p_erase_bonds = (startup_event == BSP_EVENT_CLEAR_BONDING_DATA);
    }
    
    
    /**@brief Function for initializing the nrf log module.
     */
    static void log_init(void)
    {
        ret_code_t err_code = NRF_LOG_INIT(NULL);
        APP_ERROR_CHECK(err_code);
    
        NRF_LOG_DEFAULT_BACKENDS_INIT();
    }
    
    
    /**@brief Function for initializing power management.
     */
    static void power_management_init(void)
    {
        ret_code_t err_code;
        err_code = nrf_pwr_mgmt_init();
        APP_ERROR_CHECK(err_code);
    }
    
    
    /**@brief Function for handling the idle state (main loop).
     *
     * @details If there is no pending log operation, then sleep until next the next event occurs.
     */
    static void idle_state_handle(void)
    {
        app_sched_execute();
        if (NRF_LOG_PROCESS() == false)
        {
            nrf_pwr_mgmt_run();
        }
    }
    
    
    /**@brief Function for application main entry
     */
    int main(void)
    {
        bool erase_bonds;
    
        // Initialize.
        log_init();
        timers_init();
        buttons_leds_init(&erase_bonds);
        power_management_init();
        ble_stack_init();
        scheduler_init();
        gap_params_init();
        gatt_init();
        advertising_init();
        services_init();
        sensor_simulator_init();
        conn_params_init();
        buffer_init();
        peer_manager_init();
    
        // Start execution.
        NRF_LOG_INFO("HID Keyboard example started.");
        timers_start();
        advertising_start(erase_bonds);
    
        // Enter main loop.
        for (;;)
        {
            idle_state_handle();
        }
    }
    
    
    /**
     * @}
     */
    

  • Hi Matthew

    Sorry for the slow response, I have been out in travel for the last couple of days. 

    Are you able to send me the current state of your code so I can try it out on my end? 

    Then I will block off some time tomorrow to try and dig into this. 

    Best regards
    Torbjørn

  • Hi Ovrebekk,

    No worries, I have been working hard figuring a few things out. I started pulling bluetooth packet logs off my iPhone and noticed that the report descriptor is different from the report pulled from my laptop. So once again I had to start over with decoding the report. I have found that the report usage page is a digitizer but the usage is a pen/stylus. I was able to validate the functionality on the iPhone Notes app as when I pushed the up button it gave me a "Pen" warning and started to draw a straight line. BINGO!!!

    I'm some what able to get the code to work. The problem that I have now is it will only send a total of 5 messages to the phone and not the total of 8 that I expect. Can you please review the function "digitizer_send()" and see what I need to do to make sure all 8 packets are sent in order. I get no errors. There might be a timing issue that I need to address between sending packets.  I see the screen on the phone move to the left but only partial because not all the packets are sent.

    Using nRF5_SDK_15.3.0_59ac345 for testing

    static void digitizer_send() {
      // Left Button Press Packets
      uint8_t packet_1_data[] = { 0x03, 0x20, 0xC3, 0x12 };  
      uint8_t packet_2_data[] = { 0x03, 0xBC, 0xC2, 0x12 };
      uint8_t packet_3_data[] = { 0x03, 0x58, 0xC2, 0x12 };
      uint8_t packet_4_data[] = { 0x03, 0xF4, 0xC1, 0x12 };
      uint8_t packet_5_data[] = { 0x03, 0x90, 0xC1, 0x12 };
      uint8_t packet_6_data[] = { 0x03, 0x2C, 0xC1, 0x12 };
      uint8_t packet_7_data[] = { 0x02, 0x2C, 0xC1, 0x12 };
      uint8_t packet_8_data[] = { 0x02, 0x2C, 0xC1, 0x12 };
    
      uint32_t err_code;
      err_code = ble_hids_inp_rep_send(&m_hids, INPUT_REPORT_DIG_INDEX, INPUT_REPORT_DIG_MAX_LEN, packet_1_data, m_conn_handle);
      err_code = ble_hids_inp_rep_send(&m_hids, INPUT_REPORT_DIG_INDEX, INPUT_REPORT_DIG_MAX_LEN, packet_2_data, m_conn_handle);
      err_code = ble_hids_inp_rep_send(&m_hids, INPUT_REPORT_DIG_INDEX, INPUT_REPORT_DIG_MAX_LEN, packet_3_data, m_conn_handle);
      err_code = ble_hids_inp_rep_send(&m_hids, INPUT_REPORT_DIG_INDEX, INPUT_REPORT_DIG_MAX_LEN, packet_4_data, m_conn_handle);
      err_code = ble_hids_inp_rep_send(&m_hids, INPUT_REPORT_DIG_INDEX, INPUT_REPORT_DIG_MAX_LEN, packet_5_data, m_conn_handle);
      err_code = ble_hids_inp_rep_send(&m_hids, INPUT_REPORT_DIG_INDEX, INPUT_REPORT_DIG_MAX_LEN, packet_6_data, m_conn_handle);
      err_code = ble_hids_inp_rep_send(&m_hids, INPUT_REPORT_DIG_INDEX, INPUT_REPORT_DIG_MAX_LEN, packet_7_data, m_conn_handle);
      err_code = ble_hids_inp_rep_send(&m_hids, INPUT_REPORT_DIG_INDEX, INPUT_REPORT_DIG_MAX_LEN, packet_8_data, m_conn_handle);
      //APP_ERROR_CHECK(err_code);
    }

    Packet 1: 050D 0902 A101 8501 050D 0920 A102 0942 1500 2501 7501 
    Packet 2: 9501 8102 0932 8102 9502 8101 7504 0951 250F 9501 8102 
    Packet 3: 0501 1600 0026 E803 750C 5500 6500 0930 3600 0046 E803 
    Packet 4: 9501 8102 26E8 0346 E803 0931 8102 C085 0375 0895 0115 
    Packet 5: 0125 0809 55B1 02C0 050C 0901 A101 8502 1500 2501 7501 
    Packet 6: 9518 0A23 020A 2102 0A8A 010A AE01 0A96 010A 0103 0A02 
    Packet 7: 030A 0503 0A06 030A 0703 0A08 030A 8301 0A0B 0309 4009 
    Packet 8: 3009 6509 7009 6F09 B609 CD09 B509 E209 EA09 E981 02C0
    
    0x05, 0x0D,       // USAGE_PAGE (Digitizer)
    0x09, 0x02,       // USAGE (Pen)
    0xA1, 0x01,       // Collection (Application)
    0x85, 0x01,       //    REPORT_ID 2
    0x05, 0x0D,       //    USAGE_PAGE (Digitizer)
    0x09, 0x20,       //    USAGE (Stylus)
    0xA1, 0x02,       //    Collection (Logical)
    0x09, 0x42,       //	   USAGE (Tip Switch)
    0x15, 0x00,       //	     LOGICAL_MINIMUM (0)
    0x25, 0x01,       //         LOGICAL_MAXIMUM (1)
    0x75, 0x01,       //	     REPORT_SIZE (1) 
    0x95, 0x01,       //	     REPORT_COUNT (1)
    0x81, 0x02,       //         INPUT (Data,Var,Abs)
    0x09, 0x32,       //       USAGE (In Range)
    0x81, 0x02,       //         INPUT (Data,Var,Abs)
    0x95, 0x02,       //         REPORT_COUNT (2)
    0x81, 0x01,       //         Input (Constant)
    0x75, 0x04,       //         REPORT_SIZE (4)
    0x09, 0x51,       //       USAGE (Contact Identifier)
    0x25, 0x0F,       //         LOGICAL_MAXIMUM (15)
    0x95, 0x01,       //	     REPORT_SIZE (1)
    0x81, 0x02,       //         INPUT (Data,Var,Abs)
    0x05, 0x01,       //       USAGE_PAGE (Generic Desktop)
    0x16, 0x00, 0x00, //         LOGICAL_MINIMUM (0)
    0x26, 0xE8, 0x03, //         LOGICAL_MAXIMUM (0x03E8 = 1000)
    0x75, 0x0C,       //         REPORT_SIZE (12)
    0x55, 0x00,       //         UNIT_EXPONENT (0)
    0x65, 0x00,       //         UNIT(Inch, EngLinear)
    0x09, 0x30,       //       USAGE (X)
    0x36, 0x00, 0x00, //         PHYSICAL_MINIMUM (0)
    0x46, 0xE8, 0x03, //         PHYSICAL_MAXIMUM (0x03E8 = 1000)
    0x95, 0x01,       //         REPORT_COUNT (1)
    0x81, 0x02,       //         INPUT (Data,Var,Abs)
    0x26, 0xE8, 0x03, //         LOGICAL_MAXIMUM (0x03E8 = 1000)
    0x46, 0xE8, 0x03, //         PHYSICAL_MAXIMUM (0x03E8 = 1000)
    0x09, 0x31,       //       USAGE (Y)
    0x81, 0x02,       //         INPUT (Data,Var,Abs)
    0xC0,             //    END_COLLECTION
    0x85, 0x03,       //  REPORT_ID 3
    0x75, 0x08,       //	REPORT_SIZE (8)
    0x95, 0x01,       //	REPORT_COUNT (1)
    0x15, 0x01,       //	LOGICAL_MINIMUM (1)
    0x25, 0x08,       //    LOGICAL_MAXIMUM (8)
    0x09, 0x55,       //    USAGE (Contact Count Maximum)
    0xB1, 0x02,       //    FEATURE (Data,Var,Abs)
    0xC0              // END_COLLECTION
    
    ## UP
    Value: 03F4 0132  
    Value: 03F4 2130  
    Value: 03F4 412E  
    Value: 03F4 612C  
    Value: 03F4 812A  
    Value: 03F4 A128  
    Value: 03F4 C126  
    Value: 03F4 E124  
    Value: 03F4 0123  
    Value: 03F4 2121  
    Value: 03F4 411F  
    Value: 03F4 611D  
    Value: 03F4 811B  
    Value: 03F4 A119  
    Value: 03F4 C117  
    Value: 03F4 E115  
    Value: 03F4 0114  
    Value: 02F4 0114  
    
    ## DOWN
    Value: 03F4 C112  
    Value: 03F4 A114  
    Value: 03F4 8116  
    Value: 03F4 6118  
    Value: 03F4 411A  
    Value: 03F4 211C  
    Value: 03F4 011E  
    Value: 03F4 E11F  
    Value: 03F4 C121  
    Value: 03F4 A123  
    Value: 03F4 8125  
    Value: 03F4 6127  
    Value: 03F4 4129  
    Value: 03F4 212B  
    Value: 03F4 012D  
    Value: 03F4 E12E  
    Value: 03F4 C130  
    Value: 02F4 C130  
    
    ## LEFT
    Value: 0320 C312  
    Value: 03BC C212  
    Value: 0358 C212  
    Value: 03F4 C112  
    Value: 0390 C112  
    Value: 032C C112  
    Value: 022C C112  
    Value: 022C C112  
    
    ## RIGHT 
    Value: 03C8 C012  
    Value: 032C C112  
    Value: 0390 C112  
    Value: 03F4 C112  
    Value: 0358 C212  
    Value: 03BC C212  
    Value: 02BC C212  
    Value: 022C C112  
    

    ble_app_hids_digitizer.zip

Related