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