xref: /btstack/example/pbap_client_demo.c (revision 9d65c9925326973cebda440e26e0ed853739da70)
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_run_loop.h"
58 #include "l2cap.h"
59 #include "classic/rfcomm.h"
60 #include "btstack_event.h"
61 #include "classic/goep_client.h"
62 #include "classic/pbap_client.h"
63 
64 #ifdef HAVE_BTSTACK_STDIN
65 #include "btstack_stdin.h"
66 #endif
67 
68 static void packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size);
69 
70 static bd_addr_t    remote_addr;
71 // MBP2016 "F4-0F-24-3B-1B-E1"
72 // Nexus 7 "30-85-A9-54-2E-78"
73 // iPhone SE "BC:EC:5D:E6:15:03"
74 // PTS "001BDC080AA5"
75 static  char * remote_addr_string = "DC:52:85:B4:AD:2B ";
76 
77 static char * phone_number = "911";
78 
79 static const char * pb_name   = "pb";
80 static const char * fav_name  = "fav";
81 static const char * ich_name  = "ich";
82 static const char * och_name  = "och";
83 static const char * mch_name  = "mch";
84 static const char * cch_name  = "cch";
85 static const char * spd_name  = "spd";
86 
87 static const char * phonebook_name;
88 static char phonebook_folder[30];
89 static char phonebook_path[30];
90 
91 static btstack_packet_callback_registration_t hci_event_callback_registration;
92 static uint16_t pbap_cid;
93 
94 static int sim1_selected;
95 
96 static void refresh_phonebook_folder_and_path(void){
97     sprintf(phonebook_path, "%s%s.vcf", sim1_selected ? "SIM1/telecom/" : "telecom/", phonebook_name);
98     sprintf(phonebook_folder, "%s%s",   sim1_selected ? "SIM1/telecom/" : "telecom/", phonebook_name);
99     printf("[-] Phonebook folder '%s'\n", phonebook_folder);
100     printf("[-] Phonebook path   '%s'\n", phonebook_path);
101 }
102 
103 static void select_phonebook(const char * phonebook){
104     phonebook_name = phonebook;
105     printf("[-] Phonebook name   '%s'\n", phonebook_name);
106     refresh_phonebook_folder_and_path();
107 }
108 
109 #ifdef HAVE_BTSTACK_STDIN
110 
111 // Testing User Interface
112 static void show_usage(void){
113     bd_addr_t iut_address;
114     gap_local_bd_addr(iut_address);
115 
116     printf("\n--- Bluetooth PBAP Client (HF) Test Console %s ---\n", bd_addr_to_str(iut_address));
117     printf("Phonebook:       '%s'\n", phonebook_folder);
118     // printf("Phonebook folder '%s'\n", phonebook_folder);
119     printf("Phonebook path   '%s'\n", phonebook_path);
120     printf("\n");
121     printf("a - establish PBAP connection to %s\n", bd_addr_to_str(remote_addr));
122     printf("b - select SIM1\n");
123     printf("r - set path to '/telecom'\n");
124     printf("R - set path to '/SIM1/telecom'\n");
125     printf("u - set path to '%s'\n", phonebook_folder);
126     printf("v - set vCardSelector to N and TEL\n");
127     printf("V - set vCardSelectorOperator to AND\n");
128 
129     printf("e - select phonebook '%s'\n", pb_name);
130     printf("f - select phonebook '%s'\n", fav_name);
131     printf("i - select phonebook '%s'\n", ich_name);
132     printf("o - select phonebook '%s'\n", och_name);
133     printf("m - select phonebook '%s'\n", mch_name);
134     printf("c - select phonebook '%s'\n", cch_name);
135     printf("s - select phonebook '%s'\n", spd_name);
136 
137     printf("d - get size of    '%s'\n",             phonebook_path);
138     printf("g - pull phonebook '%s'\n",             phonebook_path);
139     printf("h - pull vCard listing '%s'\n",         phonebook_folder);
140     printf("l - get vCard 0.vcf\n");
141     printf("L - get vCard X-BT-UID::1234567890ABCDEF1234567890000001\n");
142     printf("j - Lookup contact with number '%s'\n", phone_number);
143     printf("t - disconnnect\n");
144     printf("p - authenticate using password '0000'\n");
145     printf("r - set path to 'telecom'\n");
146     printf("x - abort operation\n");
147     printf("\n");
148 }
149 
150 static void stdin_process(char c){
151     switch (c){
152         case 'a':
153             printf("[+] Connecting to %s...\n", bd_addr_to_str(remote_addr));
154             pbap_connect(&packet_handler, remote_addr, &pbap_cid);
155             break;
156         case 'b':
157             printf("[+] SIM1 selected'\n");
158             sim1_selected = 1;
159             refresh_phonebook_folder_and_path();
160             break;
161 
162         case 'd':
163             printf("[+] Get size of phonebook '%s'\n", phonebook_path);
164             pbap_get_phonebook_size(pbap_cid, phonebook_path);
165             break;
166         case 'g':
167             printf("[+] Pull phonebook '%s'\n", phonebook_path);
168             pbap_pull_phonebook(pbap_cid, phonebook_path);
169             break;
170         case 'h':
171             printf("[+] Pull vCard list for '%s'\n", phonebook_folder);
172             pbap_pull_vcard_listing(pbap_cid, "");
173             break;
174         case 'j':
175             printf("[+] Lookup name for number '%s'\n", phone_number);
176             pbap_lookup_by_number(pbap_cid, phone_number);
177             break;
178         case 'l':
179             printf("[+] Pull vCard '1.vcf'\n");
180             pbap_pull_vcard_entry(pbap_cid, "1.vcf");
181             break;
182         case 'L':
183             printf("[+] Pull vCard 'X-BT-UID:1234567890ABCDEF1234567890000001'\n");
184             pbap_pull_vcard_entry(pbap_cid, "X-BT-UID:1234567890ABCDEF1234567890000001");
185             break;
186 
187         case 'c':
188             printf("[+] Select phonebook '%s'\n", cch_name);
189             select_phonebook(cch_name);
190             break;
191         case 'e':
192             printf("[+] Select phonebook '%s'\n", pb_name);
193             select_phonebook(pb_name);
194             break;
195         case 'f':
196             printf("[+] Select phonebook '%s'\n", fav_name);
197             select_phonebook(fav_name);
198             break;
199         case 'i':
200             printf("[+] Select phonebook '%s'\n", ich_name);
201             select_phonebook(ich_name);
202             break;
203         case 'm':
204             printf("[+] Select phonebook '%s'\n", mch_name);
205             select_phonebook(mch_name);
206             break;
207         case 'o':
208             printf("[+] Select phonebook '%s'\n", och_name);
209             select_phonebook(och_name);
210             break;
211         case 's':
212             printf("[+] Select phonebook '%s'\n", spd_name);
213             select_phonebook(spd_name);
214             break;
215 
216         case 'p':
217             pbap_authentication_password(pbap_cid, "0000");
218             break;
219         case 'v':
220             printf("[+] Set vCardSelector 'N' and 'TEL'\n");
221             pbap_set_vcard_selector(pbap_cid, PBAP_PROPERTY_MASK_N | PBAP_PROPERTY_MASK_TEL);
222             break;
223         case 'V':
224             printf("[+] Set vCardSelectorOperator 'AND'\n");
225             pbap_set_vcard_selector_operator(pbap_cid, PBAP_VCARD_SELECTOR_OPERATOR_AND);
226             break;
227         case 'r':
228             printf("[+] Set path to '/telecom'\n");
229             pbap_set_phonebook(pbap_cid, "telecom");
230             break;
231         case 'R':
232             printf("[+] Set path to '/SIM1/telecom'\n");
233             pbap_set_phonebook(pbap_cid, "SIM1/telecom");
234             break;
235         case 'u':
236             printf("[+] Set path to '%s'\n", phonebook_folder);
237             pbap_set_phonebook(pbap_cid, phonebook_folder);
238             break;
239         case 'x':
240             printf("[+] Abort'\n");
241             pbap_abort(pbap_cid);
242             break;
243         case 't':
244             pbap_disconnect(pbap_cid);
245             break;
246         default:
247             show_usage();
248             break;
249     }
250 }
251 
252 // packet handler for interactive console
253 static void packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
254     UNUSED(channel);
255     UNUSED(size);
256     int i;
257     uint8_t status;
258     char buffer[32];
259     switch (packet_type){
260         case HCI_EVENT_PACKET:
261             switch (hci_event_packet_get_type(packet)) {
262                 case BTSTACK_EVENT_STATE:
263                     // BTstack activated, get started
264                     if (btstack_event_state_get_state(packet) == HCI_STATE_WORKING){
265                         show_usage();
266                     }
267                     break;
268                 case HCI_EVENT_PBAP_META:
269                     switch (hci_event_pbap_meta_get_subevent_code(packet)){
270                         case PBAP_SUBEVENT_CONNECTION_OPENED:
271                             status = pbap_subevent_connection_opened_get_status(packet);
272                             if (status){
273                                 printf("[!] Connection failed, status 0x%02x\n", status);
274                             } else {
275                                 printf("[+] Connected\n");
276                             }
277                             break;
278                         case PBAP_SUBEVENT_CONNECTION_CLOSED:
279                             printf("[+] Connection closed\n");
280                             break;
281                         case PBAP_SUBEVENT_OPERATION_COMPLETED:
282                             printf("[+] Operation complete\n");
283                             break;
284                         case PBAP_SUBEVENT_AUTHENTICATION_REQUEST:
285                             printf("[?] Authentication requested\n");
286                             break;
287                         case PBAP_SUBEVENT_PHONEBOOK_SIZE:
288                             status = pbap_subevent_phonebook_size_get_status(packet);
289                             if (status){
290                                 printf("[!] Get Phonebook size error: 0x%x\n", status);
291                             } else {
292                                 printf("[+] Phonebook size: %u\n", pbap_subevent_phonebook_size_get_phonebook_size(packet));
293                             }
294                             break;
295                         case PBAP_SUBEVENT_CARD_RESULT:
296                             memcpy(buffer, pbap_subevent_card_result_get_name(packet), pbap_subevent_card_result_get_name_len(packet));
297                             buffer[pbap_subevent_card_result_get_name_len(packet)] = 0;
298                             printf("[-] Name:   '%s'\n", buffer);
299                             memcpy(buffer, pbap_subevent_card_result_get_handle(packet), pbap_subevent_card_result_get_handle_len(packet));
300                             buffer[pbap_subevent_card_result_get_handle_len(packet)] = 0;
301                             printf("[-] Handle: '%s'\n", buffer);
302                             break;
303                         default:
304                             break;
305                     }
306                     break;
307                 default:
308                     break;
309             }
310             break;
311         case PBAP_DATA_PACKET:
312             for (i=0;i<size;i++){
313                 printf("%c", packet[i]);
314             }
315             break;
316         default:
317             break;
318     }
319 }
320 #else
321 
322 // packet handler for emdded system with fixed operation sequence
323 static void packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
324     UNUSED(channel);
325     UNUSED(size);
326     int i;
327     switch (packet_type){
328         case HCI_EVENT_PACKET:
329             switch (hci_event_packet_get_type(packet)) {
330                 case BTSTACK_EVENT_STATE:
331                     // BTstack activated, get started
332                     if (btstack_event_state_get_state(packet) == HCI_STATE_WORKING){
333                         printf("[+] Connect to Phone Book Server on %s\n", bd_addr_to_str(remote_addr));
334                         pbap_connect(&packet_handler, remote_addr, &pbap_cid);
335                     }
336                     break;
337                 case HCI_EVENT_PBAP_META:
338                     switch (hci_event_pbap_meta_get_subevent_code(packet)){
339                         case PBAP_SUBEVENT_CONNECTION_OPENED:
340                             printf("[+] Connected\n");
341                             printf("[+] Pull phonebook\n");
342                             pbap_pull_phonebook(pbap_cid, phonebook_path);
343                             break;
344                         case PBAP_SUBEVENT_CONNECTION_CLOSED:
345                             printf("[+] Connection closed\n");
346                             break;
347                         case PBAP_SUBEVENT_OPERATION_COMPLETED:
348                             printf("[+] Operation complete\n");
349                             printf("[+] Pull Phonebook complete\n");
350                             pbap_disconnect(pbap_cid);
351                             break;
352                         default:
353                             break;
354                     }
355                     break;
356                 default:
357                     break;
358             }
359             break;
360         case PBAP_DATA_PACKET:
361             for (i=0;i<size;i++){
362                 printf("%c", packet[i]);
363             }
364             break;
365         default:
366             break;
367     }
368 }
369 #endif
370 
371 int btstack_main(int argc, const char * argv[]);
372 int btstack_main(int argc, const char * argv[]){
373 
374     (void)argc;
375     (void)argv;
376 
377     // init L2CAP
378     l2cap_init();
379 
380     // init RFCOM
381     rfcomm_init();
382 
383     // init GOEP Client
384     goep_client_init();
385 
386     // init PBAP Client
387     pbap_client_init();
388 
389     // register for HCI events
390     hci_event_callback_registration.callback = &packet_handler;
391     hci_add_event_handler(&hci_event_callback_registration);
392 
393     sscanf_bd_addr(remote_addr_string, remote_addr);
394 
395     select_phonebook(pb_name);
396 
397 #ifdef HAVE_BTSTACK_STDIN
398     btstack_stdin_setup(stdin_process);
399 #endif
400 
401     // turn on!
402     hci_power_control(HCI_POWER_ON);
403 
404     return 0;
405 }
406 /* EXAMPLE_END */
407