Use renamed bitfield-c dependency.
[apps/agl-service-can-low-level.git] / README.mkd
1 ISO-TP (ISO 15765-2) Support Library in C
2 ================================
3
4 ## API
5
6     IspTpHandler handler = isotp_init(42, NULL, NULL, NULL);
7     isotp_send(const uint8_t* payload, uint16_t payload_size);
8     while(true) {
9         isotp_handle_can_frame(42, data, 8);
10     }
11     isotp_destroy(&handler);
12
13 // TODO should handlers take a context? depends on how we want to use this
14
15 // TODO add an optional dispatcher to handle multiple open requests
16
17 ## Testing
18
19 The library includes a test suite that uses the `check` C unit test library.
20
21     $ make test
22
23 ## Authors
24
25 Chris Peplin cpeplin@ford.com
26
27 ## License
28
29 Copyright (c) 2013 Ford Motor Company
30
31 Licensed under the BSD license.