Updated Makefiles and CMakeLists.txt to point to resource, not oic-resource
[platform/upstream/iotivity.git] / csdk / stack / samples / arduino / SimpleClientServer / README
1 -------------------------------------------------------------------------------
2 **Arduino** -- Must be built with the same BUILD mode declared as octbstack.a.
3 -------------------------------------------------------------------------------
4 When an Arduino SimpleClientServer application is running, it outputs logs to
5 serial port. This requires the current user to be a part of the "dialout" user
6 group permissions on Ubuntu. If your Arduino device is NOT installed at
7 location "ttyACM0", you must define ARDUINO_PORT to the location it is
8 installed at. This location will be referred to as <DEV_PORT>.
9
10 You can only install one application at a time. Your choices are "oclient" or
11 "ocserver." Your selection will be referred to as <DEV_APP>.
12
13 This makefile relies on "local.properties" at the directory level of the
14 makefile that generates octbstack.a. Please refer to the README at that level
15 to determine what definitions are needed for your environment.
16
17 To make occlient or ocserver in release mode:
18
19         make
20
21 To make & install occlient or ocserver in release mode, with <DEV_PORT> specified:
22
23         make install APP_INSTALL=<DEV_APP> ARDUINO_PORT=<DEV_PORT>
24
25 To make & install occlient or ocserver in debug mode:
26
27         make install APP_INSTALL=<DEV_APP> ARDUINO_PORT=<DEV_PORT> BUILD=debug
28
29 -------------------------------------------------------------------------------
30 **Clean-Up**
31 -------------------------------------------------------------------------------
32 To clean occlient & ocserver sample apps and objects:
33
34         sudo make clean
35