xref: /btstack/example/pbap_client_demo.c (revision 2cb53b66361918abdf24ce677f652fa976540061)
1 /*
2  * Copyright (C) 2014 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
24  * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 #define BTSTACK_FILE__ "pbap_client_demo.c"
39 
40 // *****************************************************************************
41 /* EXAMPLE_START(pbap_client_demo): PBAP Client - Get Contacts from Phonebook Server
42  *
43  * @text Note: The Bluetooth address of the remote Phonbook server is hardcoded.
44  * Change it before running example, then use the UI to connect to it, to set and
45  * query contacts.
46  */
47 // *****************************************************************************
48 
49 
50 #include "btstack_config.h"
51 
52 #include <stdint.h>
53 #include <stdio.h>
54 #include <stdlib.h>
55 #include <string.h>
56 
57 #include "btstack.h"
58 
59 #ifdef HAVE_BTSTACK_STDIN
60 #include "btstack_stdin.h"
61 #endif
62 
63 static void packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size);
64 
65 static bd_addr_t    remote_addr;
66 // MBP2016 "F4-0F-24-3B-1B-E1"
67 // Nexus 7 "30-85-A9-54-2E-78"
68 // iPhone SE "BC:EC:5D:E6:15:03"
69 // PTS "001BDC080AA5"
70 static  char * remote_addr_string = "DC:52:85:B4:AD:2B ";
71 
72 static char * phone_number = "911";
73 
74 static const char * pb_name   = "pb";
75 static const char * fav_name  = "fav";
76 static const char * ich_name  = "ich";
77 static const char * och_name  = "och";
78 static const char * mch_name  = "mch";
79 static const char * cch_name  = "cch";
80 static const char * spd_name  = "spd";
81 
82 static const char * phonebook_name;
83 static char phonebook_folder[30];
84 static char phonebook_path[30];
85 
86 static btstack_packet_callback_registration_t hci_event_callback_registration;
87 static uint16_t pbap_cid;
88 
89 static int sim1_selected;
90 
91 static void refresh_phonebook_folder_and_path(void){
92     sprintf(phonebook_path, "%s%s.vcf", sim1_selected ? "SIM1/telecom/" : "telecom/", phonebook_name);
93     sprintf(phonebook_folder, "%s%s",   sim1_selected ? "SIM1/telecom/" : "telecom/", phonebook_name);
94     printf("[-] Phonebook folder '%s'\n", phonebook_folder);
95     printf("[-] Phonebook path   '%s'\n", phonebook_path);
96 }
97 
98 static void select_phonebook(const char * phonebook){
99     phonebook_name = phonebook;
100     printf("[-] Phonebook name   '%s'\n", phonebook_name);
101     refresh_phonebook_folder_and_path();
102 }
103 
104 #ifdef HAVE_BTSTACK_STDIN
105 
106 // Testing User Interface
107 static void show_usage(void){
108     bd_addr_t iut_address;
109     gap_local_bd_addr(iut_address);
110 
111     printf("\n--- Bluetooth PBAP Client (HF) Test Console %s ---\n", bd_addr_to_str(iut_address));
112     printf("Phonebook:       '%s'\n", phonebook_folder);
113     // printf("Phonebook folder '%s'\n", phonebook_folder);
114     printf("Phonebook path   '%s'\n", phonebook_path);
115     printf("\n");
116     printf("a - establish PBAP connection to %s\n", bd_addr_to_str(remote_addr));
117     printf("b - select SIM1\n");
118     printf("r - set path to '/telecom'\n");
119     printf("R - set path to '/SIM1/telecom'\n");
120     printf("u - set path to '%s'\n", phonebook_folder);
121     printf("v - set vCardSelector to N and TEL\n");
122     printf("V - set vCardSelectorOperator to AND\n");
123 
124     printf("e - select phonebook '%s'\n", pb_name);
125     printf("f - select phonebook '%s'\n", fav_name);
126     printf("i - select phonebook '%s'\n", ich_name);
127     printf("o - select phonebook '%s'\n", och_name);
128     printf("m - select phonebook '%s'\n", mch_name);
129     printf("c - select phonebook '%s'\n", cch_name);
130     printf("s - select phonebook '%s'\n", spd_name);
131 
132     printf("d - get size of    '%s'\n",             phonebook_path);
133     printf("g - pull phonebook '%s'\n",             phonebook_path);
134     printf("h - pull vCard listing '%s'\n",         phonebook_folder);
135     printf("l - get vCard 0.vcf\n");
136     printf("L - get vCard X-BT-UID::1234567890ABCDEF1234567890000001\n");
137     printf("j - Lookup contact with number '%s'\n", phone_number);
138     printf("t - disconnnect\n");
139     printf("p - authenticate using password '0000'\n");
140     printf("r - set path to 'telecom'\n");
141     printf("x - abort operation\n");
142     printf("\n");
143 }
144 
145 static void stdin_process(char c){
146     switch (c){
147         case 'a':
148             printf("[+] Connecting to %s...\n", bd_addr_to_str(remote_addr));
149             pbap_connect(&packet_handler, remote_addr, &pbap_cid);
150             break;
151         case 'b':
152             printf("[+] SIM1 selected'\n");
153             sim1_selected = 1;
154             refresh_phonebook_folder_and_path();
155             break;
156 
157         case 'd':
158             printf("[+] Get size of phonebook '%s'\n", phonebook_path);
159             pbap_get_phonebook_size(pbap_cid, phonebook_path);
160             break;
161         case 'g':
162             printf("[+] Pull phonebook '%s'\n", phonebook_path);
163             pbap_pull_phonebook(pbap_cid, phonebook_path);
164             break;
165         case 'h':
166             printf("[+] Pull vCard list for '%s'\n", phonebook_folder);
167             pbap_pull_vcard_listing(pbap_cid, "");
168             break;
169         case 'j':
170             printf("[+] Lookup name for number '%s'\n", phone_number);
171             pbap_lookup_by_number(pbap_cid, phone_number);
172             break;
173         case 'l':
174             printf("[+] Pull vCard '1.vcf'\n");
175             pbap_pull_vcard_entry(pbap_cid, "1.vcf");
176             break;
177         case 'L':
178             printf("[+] Pull vCard 'X-BT-UID:1234567890ABCDEF1234567890000001'\n");
179             pbap_pull_vcard_entry(pbap_cid, "X-BT-UID:1234567890ABCDEF1234567890000001");
180             break;
181 
182         case 'c':
183             printf("[+] Select phonebook '%s'\n", cch_name);
184             select_phonebook(cch_name);
185             break;
186         case 'e':
187             printf("[+] Select phonebook '%s'\n", pb_name);
188             select_phonebook(pb_name);
189             break;
190         case 'f':
191             printf("[+] Select phonebook '%s'\n", fav_name);
192             select_phonebook(fav_name);
193             break;
194         case 'i':
195             printf("[+] Select phonebook '%s'\n", ich_name);
196             select_phonebook(ich_name);
197             break;
198         case 'm':
199             printf("[+] Select phonebook '%s'\n", mch_name);
200             select_phonebook(mch_name);
201             break;
202         case 'o':
203             printf("[+] Select phonebook '%s'\n", och_name);
204             select_phonebook(och_name);
205             break;
206         case 's':
207             printf("[+] Select phonebook '%s'\n", spd_name);
208             select_phonebook(spd_name);
209             break;
210 
211         case 'p':
212             pbap_authentication_password(pbap_cid, "0000");
213             break;
214         case 'v':
215             printf("[+] Set vCardSelector 'N' and 'TEL'\n");
216             pbap_set_vcard_selector(pbap_cid, PBAP_PROPERTY_MASK_N | PBAP_PROPERTY_MASK_TEL);
217             break;
218         case 'V':
219             printf("[+] Set vCardSelectorOperator 'AND'\n");
220             pbap_set_vcard_selector_operator(pbap_cid, PBAP_VCARD_SELECTOR_OPERATOR_AND);
221             break;
222         case 'r':
223             printf("[+] Set path to '/telecom'\n");
224             pbap_set_phonebook(pbap_cid, "telecom");
225             break;
226         case 'R':
227             printf("[+] Set path to '/SIM1/telecom'\n");
228             pbap_set_phonebook(pbap_cid, "SIM1/telecom");
229             break;
230         case 'u':
231             printf("[+] Set path to '%s'\n", phonebook_folder);
232             pbap_set_phonebook(pbap_cid, phonebook_folder);
233             break;
234         case 'x':
235             printf("[+] Abort'\n");
236             pbap_abort(pbap_cid);
237             break;
238         case 't':
239             pbap_disconnect(pbap_cid);
240             break;
241         default:
242             show_usage();
243             break;
244     }
245 }
246 
247 // packet handler for interactive console
248 static void packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
249     UNUSED(channel);
250     UNUSED(size);
251     int i;
252     uint8_t status;
253     char buffer[32];
254     switch (packet_type){
255         case HCI_EVENT_PACKET:
256             switch (hci_event_packet_get_type(packet)) {
257                 case BTSTACK_EVENT_STATE:
258                     // BTstack activated, get started
259                     if (btstack_event_state_get_state(packet) == HCI_STATE_WORKING){
260                         show_usage();
261                     }
262                     break;
263                 case HCI_EVENT_PBAP_META:
264                     switch (hci_event_pbap_meta_get_subevent_code(packet)){
265                         case PBAP_SUBEVENT_CONNECTION_OPENED:
266                             status = pbap_subevent_connection_opened_get_status(packet);
267                             if (status){
268                                 printf("[!] Connection failed, status 0x%02x\n", status);
269                             } else {
270                                 printf("[+] Connected\n");
271                             }
272                             break;
273                         case PBAP_SUBEVENT_CONNECTION_CLOSED:
274                             printf("[+] Connection closed\n");
275                             break;
276                         case PBAP_SUBEVENT_OPERATION_COMPLETED:
277                             printf("[+] Operation complete\n");
278                             break;
279                         case PBAP_SUBEVENT_AUTHENTICATION_REQUEST:
280                             printf("[?] Authentication requested\n");
281                             break;
282                         case PBAP_SUBEVENT_PHONEBOOK_SIZE:
283                             status = pbap_subevent_phonebook_size_get_status(packet);
284                             if (status){
285                                 printf("[!] Get Phonebook size error: 0x%x\n", status);
286                             } else {
287                                 printf("[+] Phonebook size: %u\n", pbap_subevent_phonebook_size_get_phonebook_size(packet));
288                             }
289                             break;
290                         case PBAP_SUBEVENT_CARD_RESULT:
291                             memcpy(buffer, pbap_subevent_card_result_get_name(packet), pbap_subevent_card_result_get_name_len(packet));
292                             buffer[pbap_subevent_card_result_get_name_len(packet)] = 0;
293                             printf("[-] Name:   '%s'\n", buffer);
294                             memcpy(buffer, pbap_subevent_card_result_get_handle(packet), pbap_subevent_card_result_get_handle_len(packet));
295                             buffer[pbap_subevent_card_result_get_handle_len(packet)] = 0;
296                             printf("[-] Handle: '%s'\n", buffer);
297                             break;
298                         default:
299                             break;
300                     }
301                     break;
302                 default:
303                     break;
304             }
305             break;
306         case PBAP_DATA_PACKET:
307             for (i=0;i<size;i++){
308                 printf("%c", packet[i]);
309             }
310             break;
311         default:
312             break;
313     }
314 }
315 #else
316 
317 // packet handler for emdded system with fixed operation sequence
318 static void packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
319     UNUSED(channel);
320     UNUSED(size);
321     int i;
322     switch (packet_type){
323         case HCI_EVENT_PACKET:
324             switch (hci_event_packet_get_type(packet)) {
325                 case BTSTACK_EVENT_STATE:
326                     // BTstack activated, get started
327                     if (btstack_event_state_get_state(packet) == HCI_STATE_WORKING){
328                         printf("[+] Connect to Phone Book Server on %s\n", bd_addr_to_str(remote_addr));
329                         pbap_connect(&packet_handler, remote_addr, &pbap_cid);
330                     }
331                     break;
332                 case HCI_EVENT_PBAP_META:
333                     switch (hci_event_pbap_meta_get_subevent_code(packet)){
334                         case PBAP_SUBEVENT_CONNECTION_OPENED:
335                             printf("[+] Connected\n");
336                             printf("[+] Pull phonebook\n");
337                             pbap_pull_phonebook(pbap_cid, phonebook_path);
338                             break;
339                         case PBAP_SUBEVENT_CONNECTION_CLOSED:
340                             printf("[+] Connection closed\n");
341                             break;
342                         case PBAP_SUBEVENT_OPERATION_COMPLETED:
343                             printf("[+] Operation complete\n");
344                             printf("[+] Pull Phonebook complete\n");
345                             pbap_disconnect(pbap_cid);
346                             break;
347                         default:
348                             break;
349                     }
350                     break;
351                 default:
352                     break;
353             }
354             break;
355         case PBAP_DATA_PACKET:
356             for (i=0;i<size;i++){
357                 printf("%c", packet[i]);
358             }
359             break;
360         default:
361             break;
362     }
363 }
364 #endif
365 
366 int btstack_main(int argc, const char * argv[]);
367 int btstack_main(int argc, const char * argv[]){
368     (void)argc;
369     (void)argv;
370 
371     // init L2CAP
372     l2cap_init();
373 
374 #ifdef ENABLE_BLE
375     // Initialize LE Security Manager. Needed for cross-transport key derivation
376     sm_init();
377 #endif
378 
379     // init RFCOM
380     rfcomm_init();
381 
382     // init GOEP Client
383     goep_client_init();
384 
385     // init PBAP Client
386     pbap_client_init();
387 
388     // register for HCI events
389     hci_event_callback_registration.callback = &packet_handler;
390     hci_add_event_handler(&hci_event_callback_registration);
391 
392     sscanf_bd_addr(remote_addr_string, remote_addr);
393 
394     select_phonebook(pb_name);
395 
396 #ifdef HAVE_BTSTACK_STDIN
397     btstack_stdin_setup(stdin_process);
398 #endif
399 
400     // turn on!
401     hci_power_control(HCI_POWER_ON);
402 
403     return 0;
404 }
405 /* EXAMPLE_END */
406