X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=Readme.scons.txt;h=ae2dab5056faaa73ec112fb087173b75966be204;hb=03be8a9caecaa6aa5fc8a5f902a840aaa05e58a1;hp=8956c2d4af9e95de71e9081f65ae5040c0c59924;hpb=27178e2d0135760d6e8cf8b1e0936d658d192fff;p=platform%2Fupstream%2Fiotivity.git diff --git a/Readme.scons.txt b/Readme.scons.txt index 8956c2d..ae2dab5 100644 --- a/Readme.scons.txt +++ b/Readme.scons.txt @@ -1,19 +1,49 @@ -== How to build Iotivity projects == +== Quick guide: build and run IoTivity projects on Ubuntu == -Iotivity includes a series of projects. You can find all these projects here: - https://oic-review.01.org/gerrit/#/admin/projects/ +1. Build + Go to the top directory of 'iotivity' project(Note: should always run 'scons' +command in this directory) -You can build Iotivity project on Linux / Windows / MAC OSX for various OS( + Install external libraries: + $ sudo apt-get install libboost-dev libboost-program-options-dev libexpat1-dev libboost-thread-dev uuid-dev libssl-dev libtool + + Build release binaries: + $ scons +(Note: C sdk requires tinycbor. Please follow the instruction in the build +message to install tinycbor) + + Build debug binaries: + $scons RELEASE=false + + Help: + $ scons -h + + Clear: + $ scons -c + +2. Run the samples + $ export LD_LIBRARY_PATH=/out/linux/x86_64/release + Run the c++ samples in /out/linux/x86_64/release/resource/examples + Run the c samples in /out/linux/x86_64/release/resource/csdk/stack/samples/linux/SimpleClientServer +('' is the path to 'iotivity' project. If your device is x86, arm, +or arm64, please change 'x86_64' to the proper arch) + +== How to build IoTivity projects == + +IoTivity includes a series of projects. You can find all these projects here: + https://gerrit.iotivity.org/gerrit/#/admin/projects/ + +You can build IoTivity project on Linux / Windows / MAC OSX for various OS( Linux, Tizen, Android, Arduino, Windows, MAC OSX, IOS ...). The output of the build is in: - /out//// + /out//// e.g. - oic-resource/out/android/armeabi-v7a/release/. + iotivity/out/android/armeabi-v7a/release/. -This document takes oic-resource project as example, the way to build other +This document takes 'iotivity' project as example, the way to build other projects is almost the same. -=== Iotivity project build tool scons === +=== IoTivity project build tool scons === Scons is a cross-platform build tool, its usage is quite similar to GNU make. To build a project, you just require to run following command at the directory @@ -26,7 +56,16 @@ information(include build options). To see the help information: $ scons [options] -h Note: If no value is specified for an option, the default value will be used. -The change of options value may impact the output. +The change of options value may impact the help information and the behavior +of the building. + +Generally, it's required to specify the target OS and target ARCH, that's to say +tell Scons which OS and which ARCH you'd like build this project for. By default, +the target OS and ARCH is the same as the host. + +Some more options may be required, please care the 'error' notification when build. +For help about how to set an option, please run: + $ scons TARGET_OS=xxx TARGET_ARCH=yyy [XXX=zzz ...] -h === Prerequites === @@ -45,13 +84,13 @@ Android: To build for Android, Andorid NDK and SDK are required. Android NDK: http://developer.android.com/tools/sdk/ndk/index.html Android SDK: http://developer.android.com/sdk/index.html -(Note: as in some Iotivity projects, C++11 features are used, recommend Android - NDK >= r10, according to our test result r10c is the best one currently) +(Note: as in some IoTivity projects, C++11 features are used, recommend Android + NDK >= r10) Arduino: To build for Arduino, Arduino IDE is required. Arduino IDE: http://arduino.cc/en/Main/Software - (Note: recommend install Arduino IDE >=1.5.7) + (Note: recommend install Arduino IDE >=1.5.8) Arduino builds are dependent on latest Time library. Download it from here: http://www.pjrc.com/teensy/td_libs_Time.html @@ -76,67 +115,57 @@ Java codes, this isn't required) so you don't need to add it in command line each time. The build script will guide you to do that.) +Tizen: +To build for tizen platform tinycbor library is needed. +Please download tinycbor if it is not present in extlibs/tinycbor folder +by doing the following: + $ git clone https://github.com/01org/tinycbor.git extlibs/tinycbor/tinycbor + + * 3. External libraries -For Android and IOS build, most of the external libraries are provided as -binary in oic-utilities project (https://oic-review.01.org/gerrit/oic-utilities). -Please download it in the same directory as other Iotivity projects. If it's -in different directory, an additional option (OIC_UITLS) will be required. The -build command should be: - $ scons OIC_UITLS= [other options] [target] +IoTivity project depends on some external libraries, such as boost, expat ... +During building, the existence of external library will be checked, if it doesn't +exist, the build script will try to download, unpack and build the library or +notify user to install it. -(Note: for convenience, you can also add it in environment variable. So you -don't need to add this option in command line each time.) - e.g.: - $ export OIC_UITLS= +Downloading and unpacking may fail due to network problem or required unpacking +tool isn't installed. An message will be displayed, please follow the message +to skip it. -=== Build Iotivity project on Linux(Ubuntu) === +=== Build IoTivity project on Linux(Ubuntu) === -1. Build Iotivity project for Linux +1. Build IoTivity project for Linux $ cd - $ sudo apt-get install libboost-dev libboost-program-options-dev + $ sudo apt-get install libboost-dev libexpat1-dev libboost-thread-dev libssl-dev libtool $ scons -2. Build Iotivity project for Android +2. Build IoTivity project for Android $ cd $ scons TARGET_OS=android TARGET_ARCH=xxx (xxx can be x86, armeabi, armeabi-v7a, armeabi-v7a-hard. To see all of its -allowed value, please execute command 'scons TARGET_OS=android -Q -h'. - -Note: Currently as x86_64/arm64_v8a external library binaries aren't provided, -you may meet link problem if build executable binary which depends on external -library for x86_64/arm64_v8a. - -3. Build Iotivity project for Arduino - $ cd - $ scons TARGET_OS=arduino TARGET_ARCH=xxx BOARD=yyy -(xxx can be avr, arm; yyy is the name of the board, to get its allowed value -run: scons TARGET_OS=arduino TARGET_ARCH=xxx -h. You may see a option 'CPU' in -the output of above command line, that's due to some boards have different -processor, to specify the processor, add 'CPU=zzz' in the command line. If no -'CPU' option exists, that means the board only support one kind of processor, -it's unnecessary to specify it) - - -=== Build Iotivity project on Windows === +allowed value, please execute command 'scons TARGET_OS=android -Q -h') -1. Build Iotivity project for Android(It's the same as on Ubuntu) +3. Build IoTivity project for Arduino $ cd - $ scons TARGET_OS=android TARGET_ARCH=xxx -(xxx can be x86, armeabi, armeabi-v7a, armeabi-v7a-hard ...) - -2. Build Iotivity project for Arduino(It's the same as on Ubuntu) + $ sudo apt-get install dos2unix + $ scons TARGET_OS=arduino TARGET_ARCH=xxx BOARD=yyy SHIELD=zzz +(xxx can be avr, arm; yyy is the name of the board, zzz is the shield type, to +get allowed values run: scons TARGET_OS=arduino TARGET_ARCH=xxx SHIELD=zzz -h. +You may see a option 'CPU' in the output of above command line, that's due to +some boards have different processors, to specify the processor, add 'CPU=zzz' +in the command line. If no 'CPU' option exists, that means the board only +support one kind of processor, it's unnecessary to specify it) + +4. Build Iotivity project for Tizen $ cd - $ scons TARGET_OS=arduino TARGET_ARCH=xxx BOARD=yyy -(xxx can be avr, arm; yyy is the name of the board, to get its allowed value -run: scons TARGET_OS=arduino TARGET_ARCH=xxx -h. You may see a option 'CPU' in -the output of above command line, that's due to some boards have different -processor, to specify the processor, add 'CPU=zzz' in the command line. If no -'CPU' option exists, that means the board only support one kind of processor, -it's unnecessary to specify it) - + $ sh gbsbuild.sh +(we provide the spec file required by gbs tool at toools/tizen directory. +gbs is default build tool for Tizen platfrom, we can refer the following +wiki to setup Tizen development environment: +https://source.tizen.org/documentation/developer-guide/getting-started-guide) -Note: Currently most Iotivity project doesn't support Windows, so you can't set +Note: Currently most IoTivity project doesn't support Windows, so you can't set TARGET_OS to 'windows' except the project support Windows. That's to say if the project doesn't support Windows, run: @@ -146,19 +175,19 @@ or run on Windows may always fail. -=== Build Iotivity project on Mac OSX === +=== Build IoTivity project on Mac OSX === -1. Build Iotivity project for Mac OSX +1. Build IoTivity project for Mac OSX $ cd $ scons SYS_VERSION=yyy (yyy is the OSX version, e.g. 10.9) -2. Build Iotivity project for Android(It's the same as on Ubuntu) +2. Build IoTivity project for Android(It's the same as on Ubuntu) $ cd $ scons TARGET_OS=android TARGET_ARCH=xxx (xxx can be x86, armeabi, armeabi-v7a, armeabi-v7a-hard) -3. Build Iotivity project for IOS +3. Build IoTivity project for IOS $ cd $ scons TARGET_OS=ios TARGET_ARCH=xxx SYS_VERSION=yyy (xxx can be i386, x86_64, armv7, armv7s, arm64, yyy is IOS version, e.g. 7.0) @@ -168,20 +197,6 @@ Note: at once. Following is the usage: To build: - $ auto_build.sh + $ auto_build.sh To clean: $ auto_build.sh -c - -2) Last sync and test with commit e9403ce6d4d7a1a0ac8d12c5acc876af7f7a8f76 -If you meet build error with newest code, it may due to the scripts are not up -to date. Please try commit 5f16c38a5380e4b5c0d82e2cfea4af5fdc30c9ac or send mail -to . - -3) The build scripts for services have been provided. As the services code is -out of date, it must the sync with newest resource code, otherwise, it can't -pass the build, currently, the build scripts for services aren't enabled. Please -remove the '#' at line 31 in 'SConstruct' file to enable it after the code is -updated. - -4) For Arduino build, the Time library should >=1.3. The old can only be built -with Arduino IDE 1.0.x