xref: /btstack/example/pbap_client_demo.c (revision 630ffdd469bbec3276322f46b93e6cfdfcb21c27)
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 MATTHIAS
24  * RINGWALD 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): Connect to Phonebook Server and get contacts.
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 = "001BDC080AA5";
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 #ifdef HAVE_BTSTACK_STDIN
97 
98 static void select_phonebook(const char * phonebook){
99     phonebook_name = phonebook;
100     sprintf(phonebook_path, "%s%s.vcf", sim1_selected ? "SIM1/telecom/" : "telecom/", phonebook);
101     sprintf(phonebook_folder, "%s%s",   sim1_selected ? "SIM1/telecom/" : "telecom/", phonebook);
102     printf("[-] Phonebook name   '%s'\n", phonebook_name);
103     printf("[-] Phonebook folder '%s'\n", phonebook_folder);
104     printf("[-] Phonebook path   '%s'\n", phonebook_path);
105 }
106 
107 // Testig User Interface
108 static void show_usage(void){
109     bd_addr_t iut_address;
110     gap_local_bd_addr(iut_address);
111 
112     printf("\n--- Bluetooth PBAP Client (HF) Test Console %s ---\n", bd_addr_to_str(iut_address));
113     printf("Phonebook:       '%s'\n", phonebook_folder);
114     // printf("Phonebook folder '%s'\n", phonebook_folder);
115     printf("Phonebook path   '%s'\n", phonebook_path);
116     printf("\n");
117     printf("a - establish PBAP connection to %s\n", bd_addr_to_str(remote_addr));
118     printf("b - select SIM1\n");
119     printf("r - set path to '/telecom'\n");
120     printf("R - set path to '/SIM1/telecom'\n");
121     printf("u - set path to '%s'\n", phonebook_folder);
122     printf("v - set vCardSelector to N and TEL\n");
123     printf("V - set vCardSelectorOperator to AND\n");
124 
125     printf("e - select phonebook '%s'\n", pb_name);
126     printf("f - select phonebook '%s'\n", fav_name);
127     printf("i - select phonebook '%s'\n", ich_name);
128     printf("o - select phonebook '%s'\n", och_name);
129     printf("m - select phonebook '%s'\n", mch_name);
130     printf("c - select phonebook '%s'\n", cch_name);
131     printf("s - select phonebook '%s'\n", spd_name);
132 
133     printf("d - get size of    '%s'\n",             phonebook_path);
134     printf("g - pull phonebook '%s'\n",             phonebook_path);
135     printf("h - Lookup contact with number '%s'\n", phone_number);
136     printf("l - pull vCard listing '%s'\n",         phonebook_folder);
137     printf("L - get vCard 0.vcf\n");
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             select_phonebook(phonebook_folder);
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 '%s'\n", phone_number);
167             pbap_lookup_by_number(pbap_cid, phone_number);
168             break;
169         case 'l':
170             printf("[+] Pull vCard list for '%s'\n", phonebook_folder);
171             pbap_pull_vcard_listing(pbap_cid, "");
172             break;
173         case 'L':
174             printf("[+] Pull vCard '0.vcf'\n");
175             pbap_pull_vcard_entry(pbap_cid, "0.vcf");
176             break;
177 
178         case 'c':
179             printf("[+] Select phonebook '%s'\n", cch_name);
180             select_phonebook(cch_name);
181             break;
182         case 'e':
183             printf("[+] Select phonebook '%s'\n", pb_name);
184             select_phonebook(pb_name);
185             break;
186         case 'f':
187             printf("[+] Select phonebook '%s'\n", fav_name);
188             select_phonebook(fav_name);
189             break;
190         case 'i':
191             printf("[+] Select phonebook '%s'\n", ich_name);
192             select_phonebook(ich_name);
193             break;
194         case 'm':
195             printf("[+] Select phonebook '%s'\n", mch_name);
196             select_phonebook(mch_name);
197             break;
198         case 'o':
199             printf("[+] Select phonebook '%s'\n", och_name);
200             select_phonebook(och_name);
201             break;
202         case 's':
203             printf("[+] Select phonebook '%s'\n", spd_name);
204             select_phonebook(spd_name);
205             break;
206 
207         case 'p':
208             pbap_authentication_password(pbap_cid, "0000");
209             break;
210         case 'v':
211             printf("[+] Set vCardSelector 'N' and 'TEL'\n");
212             pbap_set_vcard_selector(pbap_cid, PBAP_PROPERTY_MASK_N | PBAP_PROPERTY_MASK_TEL);
213             break;
214         case 'V':
215             printf("[+] Set vCardSelectorOperator 'AND'\n");
216             pbap_set_vcard_selector_operator(pbap_cid, PBAP_VCARD_SELECTOR_OPERATOR_AND);
217             break;
218         case 'r':
219             printf("[+] Set path to '/telecom'\n");
220             pbap_set_phonebook(pbap_cid, "telecom");
221             break;
222         case 'R':
223             printf("[+] Set path to '/SIM1/telecom'\n");
224             pbap_set_phonebook(pbap_cid, "SIM1/telecom");
225             break;
226         case 'u':
227             printf("[+] Set path to '%s'\n", phonebook_folder);
228             pbap_set_phonebook(pbap_cid, phonebook_folder);
229             break;
230         case 'x':
231             printf("[+] Abort'\n");
232             pbap_abort(pbap_cid);
233             break;
234         case 't':
235             pbap_disconnect(pbap_cid);
236             break;
237         default:
238             show_usage();
239             break;
240     }
241 }
242 
243 // packet handler for interactive console
244 static void packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
245     UNUSED(channel);
246     UNUSED(size);
247     int i;
248     uint8_t status;
249     char buffer[32];
250     switch (packet_type){
251         case HCI_EVENT_PACKET:
252             switch (hci_event_packet_get_type(packet)) {
253                 case BTSTACK_EVENT_STATE:
254                     // BTstack activated, get started
255                     if (btstack_event_state_get_state(packet) == HCI_STATE_WORKING){
256                         show_usage();
257                     }
258                     break;
259                 case HCI_EVENT_PBAP_META:
260                     switch (hci_event_pbap_meta_get_subevent_code(packet)){
261                         case PBAP_SUBEVENT_CONNECTION_OPENED:
262                             status = pbap_subevent_connection_opened_get_status(packet);
263                             if (status){
264                                 printf("[!] Connection failed, status 0x%02x\n", status);
265                             } else {
266                                 printf("[+] Connected\n");
267                             }
268                             break;
269                         case PBAP_SUBEVENT_CONNECTION_CLOSED:
270                             printf("[+] Connection closed\n");
271                             break;
272                         case PBAP_SUBEVENT_OPERATION_COMPLETED:
273                             printf("[+] Operation complete\n");
274                             break;
275                         case PBAP_SUBEVENT_AUTHENTICATION_REQUEST:
276                             printf("[?] Authentication requested\n");
277                             break;
278                         case PBAP_SUBEVENT_PHONEBOOK_SIZE:
279                             status = pbap_subevent_phonebook_size_get_status(packet);
280                             if (status){
281                                 printf("[!] Get Phonebook size error: 0x%x\n", status);
282                             } else {
283                                 printf("[+] Phonebook size: %u\n", pbap_subevent_phonebook_size_get_phoneboook_size(packet));
284                             }
285                             break;
286                         case PBAP_SUBEVENT_CARD_RESULT:
287                             memcpy(buffer, pbap_subevent_card_result_get_name(packet), pbap_subevent_card_result_get_name_len(packet));
288                             buffer[pbap_subevent_card_result_get_name_len(packet)] = 0;
289                             printf("[-] Name:   '%s'\n", buffer);
290                             memcpy(buffer, pbap_subevent_card_result_get_handle(packet), pbap_subevent_card_result_get_handle_len(packet));
291                             buffer[pbap_subevent_card_result_get_handle_len(packet)] = 0;
292                             printf("[-] Handle: '%s'\n", buffer);
293                             break;
294                         default:
295                             break;
296                     }
297                     break;
298                 default:
299                     break;
300             }
301             break;
302         case PBAP_DATA_PACKET:
303             for (i=0;i<size;i++){
304                 printf("%c", packet[i]);
305             }
306             break;
307         default:
308             break;
309     }
310 }
311 #else
312 
313 // packet handler for emdded system with fixed operation sequence
314 static void packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
315     UNUSED(channel);
316     UNUSED(size);
317     int i;
318     switch (packet_type){
319         case HCI_EVENT_PACKET:
320             switch (hci_event_packet_get_type(packet)) {
321                 case BTSTACK_EVENT_STATE:
322                     // BTstack activated, get started
323                     if (btstack_event_state_get_state(packet) == HCI_STATE_WORKING){
324                         printf("[+] Connect to Phone Book Server on %s\n", bd_addr_to_str(remote_addr));
325                         pbap_connect(&packet_handler, remote_addr, &pbap_cid);
326                     }
327                     break;
328                 case HCI_EVENT_PBAP_META:
329                     switch (hci_event_pbap_meta_get_subevent_code(packet)){
330                         case PBAP_SUBEVENT_CONNECTION_OPENED:
331                             printf("[+] Connected\n");
332                             printf("[+] Pull phonebook\n");
333                             pbap_pull_phonebook(pbap_cid);
334                             break;
335                         case PBAP_SUBEVENT_CONNECTION_CLOSED:
336                             printf("[+] Connection closed\n");
337                             break;
338                         case PBAP_SUBEVENT_OPERATION_COMPLETED:
339                             printf("[+] Operation complete\n");
340                             printf("[+] Pull Phonebook complete\n");
341                             pbap_disconnect(pbap_cid);
342                             break;
343                         default:
344                             break;
345                     }
346                     break;
347                 default:
348                     break;
349             }
350             break;
351         case PBAP_DATA_PACKET:
352             for (i=0;i<size;i++){
353                 printf("%c", packet[i]);
354             }
355             break;
356         default:
357             break;
358     }
359 }
360 #endif
361 
362 int btstack_main(int argc, const char * argv[]);
363 int btstack_main(int argc, const char * argv[]){
364 
365     (void)argc;
366     (void)argv;
367 
368     // init L2CAP
369     l2cap_init();
370 
371     // init RFCOM
372     rfcomm_init();
373 
374     // init GOEP Client
375     goep_client_init();
376 
377     // init PBAP Client
378     pbap_client_init();
379 
380     // register for HCI events
381     hci_event_callback_registration.callback = &packet_handler;
382     hci_add_event_handler(&hci_event_callback_registration);
383 
384     sscanf_bd_addr(remote_addr_string, remote_addr);
385 
386     select_phonebook(pb_name);
387 
388 #ifdef HAVE_BTSTACK_STDIN
389     btstack_stdin_setup(stdin_process);
390 #endif
391 
392     // turn on!
393     hci_power_control(HCI_POWER_ON);
394 
395     return 0;
396 }
397 /* EXAMPLE_END */
398