ble_uis.h

Go to the documentation of this file.

/*
  Copyright (c) 2010 - 2017, Nordic Semiconductor ASA
  All rights reserved.

  Redistribution and use in source and binary forms, with or without modification,
  are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this
     list of conditions and the following disclaimer.

  2. Redistributions in binary form, except as embedded into a Nordic
     Semiconductor ASA integrated circuit in a product or a software update for
     such product, must reproduce the above copyright notice, this list of
     conditions and the following disclaimer in the documentation and/or other
     materials provided with the distribution.

  3. Neither the name of Nordic Semiconductor ASA nor the names of its
     contributors may be used to endorse or promote products derived from this
     software without specific prior written permission.

  4. This software, with or without modification, must only be used with a
     Nordic Semiconductor ASA integrated circuit.

  5. Any software provided in binary form under this license must not be reverse
     engineered, decompiled, modified and/or disassembled.

  THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef BLE_UIS_H__
#define BLE_UIS_H__

#include <stdint.h>
#include <stdbool.h>
#include "ble.h"
#include "ble_srv_common.h"
#include "app_util_platform.h"

#define BLE_UIS_UUID_BASE        {{0x42, 0x00, 0x74, 0xA9, 0xFF, 0x52, 0x10, 0x9B, 0x33, 0x49, 0x35, 0x9B, 0x00, 0x00, 0x68, 0xEF}}

#define BLE_UIS_UUID_SERVICE     0x0300     
#define BLE_UIS_UUID_LED_CHAR    0x0301     
#define BLE_UIS_UUID_BUTTON_CHAR 0x0302     
#define BLE_UIS_UUID_PIN_CHAR    0x0303     
#ifdef __GNUC__
    #ifdef PACKED
        #undef PACKED
    #endif

    #define PACKED(TYPE) TYPE __attribute__ ((packed))
#endif

typedef enum
{
    BLE_UIS_LED_MODE_OFF,               
    BLE_UIS_LED_MODE_CONST,             
    BLE_UIS_LED_MODE_BREATHE,           
    BLE_UIS_LED_MODE_BREATHE_ONE_SHOT   
}ble_uis_led_mode_t;

#define BLE_UIS_LED_MODE_MIN BLE_UIS_LED_MODE_OFF               
#define BLE_UIS_LED_MODE_MAX BLE_UIS_LED_MODE_BREATHE_ONE_SHOT  
#define BLE_UIS_LED_MODE_OFF_LENGTH                     1       
#define BLE_UIS_LED_MODE_CONST_LENGTH                   4       
#define BLE_UIS_LED_MODE_BREATHE_LENGTH                 5       
#define BLE_UIS_LED_MODE_BREATHE_ONE_SHOT_LENGTH        3       
#define BLE_UIS_LED_COLOR_MIX_MIN                       1       
#define BLE_UIS_LED_COLOR_MIX_MAX                       7       
#define BLE_UIS_LED_INTENSITY_MIN                       1       
#define BLE_UIS_LED_INTENSITY_MAX                       100     
#define BLE_UIS_LED_DELAY_MIN                           1       
#define BLE_UIS_LED_DELAY_MAX                           10000   
typedef PACKED( union
{
    PACKED( struct
    {
        uint8_t r;          
        uint8_t g;          
        uint8_t b;          
    })mode_const;
    PACKED( struct
    {
        uint8_t  color_mix; 
        uint8_t  intensity; 
        uint16_t delay;     
    })mode_breathe;
    PACKED( struct
    {
        uint8_t color_mix;  
        uint8_t intensity;  
    })mode_breathe_one_shot;
}) ble_uis_led_data_t;

typedef PACKED( struct
{
    ble_uis_led_mode_t mode;
    ble_uis_led_data_t data;
}) ble_uis_led_t;

typedef PACKED( struct
{
    uint8_t mos_1;  
    uint8_t mos_2;  
    uint8_t mos_3;  
    uint8_t mos_4;  
}) ble_uis_pin_t;

typedef struct ble_uis_s ble_uis_t;

typedef void (*ble_uis_led_write_handler_t) (ble_uis_t * p_uis, ble_uis_led_t * rgb);

typedef void (*ble_uis_pin_write_handler_t) (ble_uis_t * p_uis, ble_uis_pin_t * pin);

typedef struct
{
    ble_uis_pin_t               init_pin;
    ble_uis_led_t             * p_init_led;
    ble_uis_led_write_handler_t led_write_handler; 
    ble_uis_pin_write_handler_t pin_write_handler; 
} ble_uis_init_t;

struct ble_uis_s
{
    uint16_t                    service_handle;            
    ble_gatts_char_handles_t    led_char_handles;          
    ble_gatts_char_handles_t    pin_char_handles;          
    ble_gatts_char_handles_t    button_char_handles;       
    uint8_t                     uuid_type;                 
    uint16_t                    conn_handle;               
    bool                        is_button_notif_enabled;
    ble_uis_led_write_handler_t led_write_handler;         
    ble_uis_pin_write_handler_t pin_write_handler;         
};

uint32_t ble_uis_init(ble_uis_t * p_uis, const ble_uis_init_t * p_uis_init);

void ble_uis_on_ble_evt(ble_uis_t * p_uis, ble_evt_t * p_ble_evt);

uint32_t ble_uis_on_button_change(ble_uis_t * p_uis, uint8_t buttons_state);

#endif // BLE_UIS_H__