Imported Upstream version 0.9.1
[platform/upstream/iotivity.git] / resource / csdk / connectivity / RELEASE v0.7
1 Project Name: IoTivity
2 Release Version No: CA_v0.7
3 API Version: CA_v0.8
4
5 Release Description:
6 Connectivity Abstraction provides a unified approach to send different OIC messages across multiple transports.
7
8 Supported Platform OS: 
9 1) Ubuntu 12.0.4 and above:
10         Connectivity : WIFI, ETHERNET
11         Security : DTLS for WIFI
12 2) Tizen 2.3
13         Connectivity : WIFI, EDR, BLE(1:1).
14 3) Arduino Mega
15         Connectivity : WIFI, ETH,BLE
16 4) Android 5.0s
17         Connectivity : WIFI, BLE
18
19 Preconditions:
20 1)gcc 4.6.3 and above.
21 2)glib library (sudo apt-get install libglib2.0-dev) for linux, tizen and android devices
22 3)libcoap.a library ( do make @lib/libcoap-4.1.1)
23 4)tinyDTLS library for DTLS enabled applications( enable DTLS = 1 in makefile @connectivity\build/linux)
24 5)Ethernet, BLE, TimedActions, Timer libraries for arduino support.
25 6)scons for scons script compilation.
26
27 Scope of Release:
28 1. Supported APIs ( please check below APIs)
29 2. Samples to test for Supported APIs.
30 3. OIC Coding guidelines followed based on the current CSDK source.
31 4. Multi-Threaded, Single threaded Connectivity abstraction.
32 5. Executed Open Source Verification and Prevent analysis.
33 Type of Release: Source
34 The following Connectivity Abstraction API features are supported in this release:
35
36 Supported APIs
37 CAInitialize()
38 CATerminate()
39 CAStartListeningServer()
40 CAStartDiscoveryServer()
41 CARegisterHandler()
42 CAhandleRequestResponse()
43 FindResource()
44 SendRequest()
45 SendResponse()
46 SelectNetwork()
47 UnselectNetwork()
48 SendNotification()
49 AdvertizeResource()
50 CAGenerateToken()
51 CADestryToken()
52 CAGetNetworkInfo()
53
54
55 Known and Open Issues:
56 1) OIC Log, OIC Malloc will be removed once name changes applied to OIC Bases code.
57 2) Tizen platform BLE stack is not stable. So we may see random crashes.
58
59 How to Build for Linux:
60 Follow below steps to execute CA Client / server in different systems
61 Step 1: Build Libcoap library
62 Make File Location @connectivity\lib\libcoap-4.1.1
63 Step 2: Build CA library
64 Make File Location @connectivity\build\linux
65 Step 3: Samples
66 Make File Location @connectivity\samples\linux
67
68 Execution:
69 linux$ export LD_LIBRARY_PATH=../../build/out/
70 linux$ ./out/sample_main
71
72
73 Follow below sequence to test
74
75 Client Option:   c
76 Server Option:  s
77
78 Client Option:  f (provide a/light)
79 Server Option: h (will pick from queue and send response)
80 Client Option:  h (to pick server response)
81
82 Client Option:  r (provide “ServerIP:5383/a/request”)
83 Server Option: h (will pick from queue and send response)
84 Client Option:  h (to pick server response)
85
86 Server Option: a
87 Client Option: h (to pick server response)
88
89 Server Option: b (provide ServerIP:5383/a/notify)
90 Client Option: h (to pick server response)
91
92 Client: Server side: n for network selection (WIFI enabled by default)
93
94
95 How to Build for Linux/DTLS:
96 ./sample.sh WITH_DTLS @@connectivity\samples\linux
97