Difference between revisions of "Template:FriendlyThings Installation Guide"

From FriendlyELEC WiKi
Jump to: navigation, search
(updated by API)
(updated by API)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
==快速使用入门==
+
==Quick Start==
−
===(第1步) 集成libfriendlyarm-things.so到你的app===
+
===Step 1: Include libfriendlyarm-things.so in APP===
−
克隆以下仓库到本地:
+
Clone the following library locally:
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
git clone https://github.com/friendlyarm/friendlythings-sdk
 
git clone https://github.com/friendlyarm/friendlythings-sdk
 
</syntaxhighlight>
 
</syntaxhighlight>
−
接着复制 libs 目录下的所有内容到你的工程目录下，然后在你的Android项目的src目录下创建com/friendlyarm目录，将java/FriendlyThings目录拷贝进去即可，最后的目录的结构看上去是这样的 (注：AndroidStudio的项目可能会稍有不同，但大致如此)：<br />
+
Copy all the files under the libs directory to your working directory and create a "com/friendlyarm" directory in your Android project's src directory, copy the whole "java/FriendlyThings" to your newly created "com/friendlyarm" directory. The whole project directory will look like this(Note:AndroidStudio's project may be a little bit different):<br />
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
YourProject/
 
YourProject/
Line 26: Line 26:
 
│          │   └── WatchDogEnum.java
 
│          │   └── WatchDogEnum.java
 
</syntaxhighlight>
 
</syntaxhighlight>
−
使用以下方法导入它们，主要的接口都集中在 HardwareControler.java文件中：
+
Import the following components and the major APIs are included in the HardwareControler.java file:
 
<syntaxhighlight lang="java">
 
<syntaxhighlight lang="java">
 
import com.friendlyarm.FriendlyThings.HardwareControler;
 
import com.friendlyarm.FriendlyThings.HardwareControler;
Line 34: Line 34:
 
import com.friendlyarm.FriendlyThings.BoardType;
 
import com.friendlyarm.FriendlyThings.BoardType;
 
</syntaxhighlight>
 
</syntaxhighlight>
−
===(第2步) 让你的app拥有system权限===
+
===Step 2: Give APP System Right===
−
你的app需要拥有system权限，才能访问硬件资源; <br />
+
Your app needs the system right to access hardware resources;<br />
−
请参考下面的方法修改你 app 的 AndroidManifest.xml 和 Android.mk这两个文件; <br />
+
Give your app the system right by making changes in the AndroidManifest.xml file and the Android.mk file;<br />
−
并且最好将你的app放到Android源码中去编译，这一步不是必需的，但是建议这么做，如果你的app在外部编译，你需要对apk进行签名才能让你的app拥有system权限（新手不太建议，过程比较繁琐）。<br />
+
It is better to include your app in your Android source code and compile them together. If your app is not compiled together with your Android source code you have to go through tedious steps to compile your app and sign your app to give it the system right.<br />
−
====修改AndroidManifest.xml====
+
====Modify AndroidManifest.xml====
−
在应用程序的AndroidManifest.xml中的manifest节点中加入以下属性：
+
Add the following line in the manifest node in the AndroidManifest.xml file:
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
android:sharedUserId="android.uid.system"
 
android:sharedUserId="android.uid.system"
 
</syntaxhighlight>
 
</syntaxhighlight>
−
====修改Android.mk====
+
====Modify Android.mk====
−
编写一个Android.mk文件(最简单的方法就是拷贝示例中的Android.mk文件)，修改Android.mk文件，加入LOCAL_CERTIFICATE := platform这一行:
+
Create an Android.mk file(the simplest way is to copy a sample Android.mk file), modify the Android.mk file by adding a line LOCAL_CERTIFICATE := platform :
 
<syntaxhighlight lang="java">
 
<syntaxhighlight lang="java">
 
LOCAL_PATH:= $(call my-dir)
 
LOCAL_PATH:= $(call my-dir)
Line 51: Line 51:
 
LOCAL_SRC_FILES := $(call all-subdir-java-files)
 
LOCAL_SRC_FILES := $(call all-subdir-java-files)
  
−
LOCAL_PACKAGE_NAME := 你的项目名
+
LOCAL_PACKAGE_NAME := Project Name
  
 
LOCAL_CERTIFICATE := platform
 
LOCAL_CERTIFICATE := platform
Line 59: Line 59:
 
include $(BUILD_PACKAGE)
 
include $(BUILD_PACKAGE)
 
</syntaxhighlight>
 
</syntaxhighlight>
−
===(最后1步) 在 Android源代码中编译你的app===
+
===Final Step: Compile Your APP Together with Android Source Code===
−
先在 Android源代码根目录调用 setenv.sh 导出环境变量，然后进入你的 app 目录，使用mm命令编译; <br />
+
Go to Android source code's root directory and run "setenv.sh" to export environmental variables, enter your app's directory and run "mm" to compile:<br />
−
例子：编译 GPIO_LED_Demo，以RK3399平台为例: <br />
+
For example: compile the GPIO_LED_Demo on RK3399:<br />
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
cd rk3399-android-8.1
 
cd rk3399-android-8.1
Line 68: Line 68:
 
mm
 
mm
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
===Sample project in Android Studio===
 +
https://github.com/friendlyarm/AndroidStudio-GPIODemo

Latest revision as of 06:30, 28 August 2023

1 Quick Start

1.1 Step 1: Include libfriendlyarm-things.so in APP

Clone the following library locally: 

git clone https://github.com/friendlyarm/friendlythings-sdk

Copy all the files under the libs directory to your working directory and create a "com/friendlyarm" directory in your Android project's src directory, copy the whole "java/FriendlyThings" to your newly created "com/friendlyarm" directory. The whole project directory will look like this(Note:AndroidStudio's project may be a little bit different):

YourProject/
├── AndroidManifest.xml
├── libs
│   ├── arm64-v8a
│   │   └── libfriendlyarm-things.so
│   └── armeabi
│       └── libfriendlyarm-things.so
├── src
│   └── com
│       └── friendlyarm
│           ├── FriendlyThings
│           │   ├── BoardType.java
│           │   ├── FileCtlEnum.java
│           │   ├── GPIOEnum.java
│           │   ├── HardwareControler.java
│           │   ├── SPIEnum.java
│           │   ├── SPI.java
│           │   └── WatchDogEnum.java

Import the following components and the major APIs are included in the HardwareControler.java file: 

import com.friendlyarm.FriendlyThings.HardwareControler;
import com.friendlyarm.FriendlyThings.SPIEnum;
import com.friendlyarm.FriendlyThings.GPIOEnum;
import com.friendlyarm.FriendlyThings.FileCtlEnum;
import com.friendlyarm.FriendlyThings.BoardType;

1.2 Step 2: Give APP System Right

Your app needs the system right to access hardware resources;
Give your app the system right by making changes in the AndroidManifest.xml file and the Android.mk file;
It is better to include your app in your Android source code and compile them together. If your app is not compiled together with your Android source code you have to go through tedious steps to compile your app and sign your app to give it the system right.

1.2.1 Modify AndroidManifest.xml

Add the following line in the manifest node in the AndroidManifest.xml file: 

android:sharedUserId="android.uid.system"

1.2.2 Modify Android.mk

Create an Android.mk file(the simplest way is to copy a sample Android.mk file), modify the Android.mk file by adding a line LOCAL_CERTIFICATE := platform : 

LOCAL_PATH:= $(call my-dir)
include $(CLEAR_VARS)
 
LOCAL_SRC_FILES := $(call all-subdir-java-files)
 
LOCAL_PACKAGE_NAME := Project Name
 
LOCAL_CERTIFICATE := platform
LOCAL_MODULE_TAGS := optional
LOCAL_CFLAGS := -lfriendlyarm-hardware
 
include $(BUILD_PACKAGE)

1.3 Final Step: Compile Your APP Together with Android Source Code

Go to Android source code's root directory and run "setenv.sh" to export environmental variables, enter your app's directory and run "mm" to compile:
For example: compile the GPIO_LED_Demo on RK3399:

cd rk3399-android-8.1
. setenv.sh
cd vendor/friendlyelec/apps/GPIO_LED_Demo
mm

1.4 Sample project in Android Studio

https://github.com/friendlyarm/AndroidStudio-GPIODemo

Retrieved from "https://wiki.friendlyelec.com/wiki/index.php?title=Template:FriendlyThings_Installation_Guide&oldid=25012"