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