Android: Difference between revisions

(6 intermediate revisions by 5 users not shown)

Line 1:

== Using the Android SDK ==

NixOS uses the androidenv package for building android SDKs and manually creating emulators without the use of Android Studio. Example android sdk is <code>androidenv.~~androidPkgs_9_0~~.androidsdk</code>. They also include all of the SDK tools such as sdkmanager and avdmanager needed to create emulators.

{{Note|<code>androidenv.androidPkgs_9_0</code> has been replaced with <code>androidenv.androidPkgs</code> in nixos 24.11, see [https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/release-notes/rl-2411.section.md#backward-incompatibilities-sec-release-2411-incompatibilities backward-incompatibilities-sec-release-2411-incompatibilities], so all the <code>~~androidPkgs_9_0~~</code> references below ~~need~~ be ~~changed after~~ 24.~~11 gets released~~.}}

NixOS uses the androidenv package for building android SDKs and manually creating emulators without the use of Android Studio. Example android sdk is <code>androidenv.androidPkgs.androidsdk</code>. They also include all of the SDK tools such as sdkmanager and avdmanager needed to create emulators.

{{Note|<code>androidenv.androidPkgs_9_0</code> has been replaced with <code>androidenv.androidPkgs</code> in nixos 24.11, see [https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/release-notes/rl-2411.section.md#backward-incompatibilities-sec-release-2411-incompatibilities backward-incompatibilities-sec-release-2411-incompatibilities], so all the <code>androidPkgs</code> references below will be androidPkgs_9_0 if you are still using 24.05 or below.}}

The first link provides a guide for creating a custom android SDK, using a predefined SDK, and how to nixify an emulator. The second link is an extra guide that might have some helpful tips for improving your workflow.

# [https://nixos.org/manual/nixpkgs/unstable/#android Official Android SDK guide from NixOS.org]

Line 93:

Line 96:

$ # For nixos < 19.03

$ # nix-shell -p androidenv.platformTools

$ # for nixos <= 24.05

$ nix-shell -p androidenv.androidPkgs_9_0.platform-tools

$ # For nixos >= 24.11

$ nix-shell -p androidenv.androidPkgs.platform-tools

% adb devices

Line 115:

Line 123:

~~$ # For nixos < 19.03~~

$ nix-shell -p androidenv.androidPkgs.platform-tools

~~$ # nix-shell -p androidenv.platformTools~~

$ nix-shell -p androidenv.~~androidPkgs_9_0~~.platform-tools

% adb connect 192.168.1.10

% adb shell

Line 145:

Line 151:

nixpkgs.config.android_sdk.accept_license = true;

</syntaxhighlight>

To use the Android Emulator, you need to enable KVM virtualization (in your BIOS) and make sure your user has permission to use KVM (add yourself to the <code>kvm</code> group).

=== gradlew ===

Line 157:

Line 165:

targetPkgs = pkgs: (with pkgs;

[

androidenv.~~androidPkgs_9_0~~.androidsdk

androidenv.androidPkgs.androidsdk

glibc

]);

Line 170:

Line 178:

let

androidSdk = pkgs.androidenv.~~androidPkgs_9_0~~.androidsdk;

androidSdk = pkgs.androidenv.androidPkgs.androidsdk;

in

pkgs.mkShell {

Line 186:

Line 194:

=== Building Android on NixOS ===

It's possible to use nix-shell with ~~buildFHSUserEnv~~ to set up an environment in which it's viable to build Android without huge amounts of editing. This is an example shell.nix file.

It's possible to use nix-shell with buildFHSEnv to set up an environment in which it's viable to build Android without huge amounts of editing. This is an example shell.nix file.

{ pkgs ? import <nixpkgs> {} }:

let fhs = pkgs.~~buildFHSUserEnv~~ {

let fhs = pkgs.buildFHSEnv {

name = "android-env";

targetPkgs = pkgs: with pkgs;

Line 203:

Line 211:

gnumake

nettools

androidenv.~~androidPkgs_9_0~~.platform-tools

androidenv.androidPkgs.platform-tools

jdk

schedtool

Line 239:

Line 247:

=== Android Debug Bridge ===

Run <code>nix-shell -p usbutils --run "lsusb"</code> on your terminal to get the list of USB devices connected to your computer. Sample output:<pre>

...

Bus 002 Device 001: ID 1d6b:0003 Linux Foundation 3.0 root hub

Bus 002 Device 007: ID 0fce:320d Sony Ericsson Mobile Communications AB Xperia 5 III

Bus 003 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub

...

</pre>

<code>ID 0fce:320d</code> can be seen as: <code>idVendor = 0fce</code> and <code>idProduct = 320d</code>.

{

programs.adb.enable = true;

services.udev.extraRules = ''

services.udev.extraRules =

# ~~replace~~ the "[]" ~~for~~ the ~~idVendor and idProduct variable~~

let

SUBSYSTEM=="usb", ATTR{idVendor}=="[]", MODE="[]", GROUP="adbusers", TAG+="uaccess"

# nix-shell -p usbutils --run "lsusb"

SUBSYSTEM=="usb", ATTR{idVendor}=="[]", ATTR{idProduct}=="[]", SYMLINK+="android_adb"

idVendor = "0fce"; # Change according to the guide above

SUBSYSTEM=="usb", ATTR{idVendor}=="[]", ATTR{idProduct}=="[]", SYMLINK+="android_fastboot"

idProduct = "320d"; # Change according to the guide above

'';

in

''

SUBSYSTEM=="usb", ATTR{idVendor}=="${idVendor}", MODE="[]", GROUP="adbusers", TAG+="uaccess"

SUBSYSTEM=="usb", ATTR{idVendor}=="${idVendor}", ATTR{idProduct}=="${idProduct}", SYMLINK+="android_adb"

SUBSYSTEM=="usb", ATTR{idVendor}=="${idVendor}", ATTR{idProduct}=="${idProduct}", SYMLINK+="android_fastboot"

'';

# add user to adbusers group

Line 257:

Line 280:

}

</syntaxhighlight>

# [https://nixos.org/nix-dev/2015-April/016881.html more information on that snippet]

# [https://gist.github.com/Nadrieril/d006c0d9784ba7eff0b092796d78eb2a A shell.nix to build LineageOS]

Line 262:

Line 286:

# [https://github.com/mrVanDalo/LineagoOS-build LineageOS build setup using terranix and hcloud], based on the [https://gist.github.com/Nadrieril/d006c0d9784ba7eff0b092796d78eb2a shell.nix to build LineageOS]. Useful if you are in a rush and don't have to much CPU power on your hand.

# [https://wiki.archlinux.org/title/Android_Debug_Bridge Archlinux Wiki to Android_Debug_Bridge]

[[Category:Development]]

@@ Line 1: / Line 1: @@
 == Using the Android SDK ==
-NixOS uses the androidenv package for building android SDKs and manually creating emulators without the use of Android Studio. Example android sdk is <code>androidenv.androidPkgs_9_0.androidsdk</code>. They also include all of the SDK tools such as sdkmanager and avdmanager needed to create emulators.
-{{Note|<code><small>androidenv.androidPkgs_9_0</small></code> has been replaced with <code><u><small>androidenv.androidPkgs</small></u></code> in nixos 24.11, see [https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/release-notes/rl-2411.section.md#backward-incompatibilities-sec-release-2411-incompatibilities backward-incompatibilities-sec-release-2411-incompatibilities], so all the <code><small>androidPkgs_9_0</small></code> references below need be changed after 24.11 gets released.}}
+NixOS uses the androidenv package for building android SDKs and manually creating emulators without the use of Android Studio. Example android sdk is <code>androidenv.androidPkgs.androidsdk</code>. They also include all of the SDK tools such as sdkmanager and avdmanager needed to create emulators.
+{{Note|<code><small>androidenv.androidPkgs_9_0</small></code> has been replaced with <code><u><small>androidenv.androidPkgs</small></u></code> in nixos 24.11, see [https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/release-notes/rl-2411.section.md#backward-incompatibilities-sec-release-2411-incompatibilities backward-incompatibilities-sec-release-2411-incompatibilities], so all the <code><small>androidPkgs</small></code> references below will be androidPkgs_9_0 if you are still using 24.05 or below.}}
 The first link provides a guide for creating a custom android SDK, using a predefined SDK, and how to nixify an emulator. The second link is an extra guide that might have some helpful tips for improving your workflow.
 # [https://nixos.org/manual/nixpkgs/unstable/#android Official Android SDK guide from NixOS.org]
@@ Line 93: / Line 96: @@
 <syntaxhighlight lang=console>
+$ # For nixos < 19.03
+$ # nix-shell -p androidenv.platformTools
+$ # for nixos <= 24.05
+$ nix-shell -p androidenv.androidPkgs_9_0.platform-tools
+$ # For nixos >= 24.11
 $ nix-shell -p androidenv.androidPkgs.platform-tools
 % adb devices
@@ Line 115: / Line 123: @@
 <syntaxhighlight lang=console>
-$ # For nixos < 19.03
+$ nix-shell -p androidenv.androidPkgs.platform-tools
-$ # nix-shell -p androidenv.platformTools
-$ nix-shell -p androidenv.androidPkgs_9_0.platform-tools
 % adb connect 192.168.1.10
 % adb shell
@@ Line 145: / Line 151: @@
 nixpkgs.config.android_sdk.accept_license = true;
 </syntaxhighlight>
+To use the Android Emulator, you need to enable KVM virtualization (in your BIOS) and make sure your user has permission to use KVM (add yourself to the <code>kvm</code> group).
 === gradlew ===
@@ Line 157: / Line 165: @@
    targetPkgs = pkgs: (with pkgs;
      [
-       androidenv.androidPkgs_9_0.androidsdk
+       androidenv.androidPkgs.androidsdk
        glibc
      ]);
@@ Line 170: / Line 178: @@
 let
-   androidSdk = pkgs.androidenv.androidPkgs_9_0.androidsdk;
+   androidSdk = pkgs.androidenv.androidPkgs.androidsdk;
 in
 pkgs.mkShell {
@@ Line 186: / Line 194: @@
 === Building Android on NixOS ===
-It's possible to use nix-shell with buildFHSUserEnv to set up an environment in which it's viable to build Android without huge amounts of editing. This is an example shell.nix file.
+It's possible to use nix-shell with buildFHSEnv to set up an environment in which it's viable to build Android without huge amounts of editing. This is an example shell.nix file.
 <syntaxhighlight lang="nix">
 { pkgs ? import <nixpkgs> {} }:
-let fhs = pkgs.buildFHSUserEnv {
+let fhs = pkgs.buildFHSEnv {
    name = "android-env";
    targetPkgs = pkgs: with pkgs;
@@ Line 203: / Line 211: @@
        gnumake
        nettools
-       androidenv.androidPkgs_9_0.platform-tools
+       androidenv.androidPkgs.platform-tools
        jdk
        schedtool
@@ Line 239: / Line 247: @@
 === Android Debug Bridge ===
+Run <code>nix-shell -p usbutils --run "lsusb"</code> on your terminal to get the list of USB devices connected to your computer. Sample output:<pre>
+...
+Bus 002 Device 001: ID 1d6b:0003 Linux Foundation 3.0 root hub
+Bus 002 Device 007: ID 0fce:320d Sony Ericsson Mobile Communications AB Xperia 5 III
+Bus 003 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
+...
+</pre>
+<code>ID 0fce:320d</code> can be seen as: <code>idVendor = 0fce</code> and <code>idProduct = 320d</code>.
 <syntaxhighlight lang="nix">
 {
    programs.adb.enable = true;
-   services.udev.extraRules = ''
+   services.udev.extraRules =
-     # replace the "[]" for the idVendor and idProduct variable
+     let
-     SUBSYSTEM=="usb", ATTR{idVendor}=="[]", MODE="[]", GROUP="adbusers", TAG+="uaccess"
+      # nix-shell -p usbutils --run "lsusb"
-    SUBSYSTEM=="usb", ATTR{idVendor}=="[]", ATTR{idProduct}=="[]", SYMLINK+="android_adb"
+      idVendor = "0fce"; # Change according to the guide above
-    SUBSYSTEM=="usb", ATTR{idVendor}=="[]", ATTR{idProduct}=="[]", SYMLINK+="android_fastboot"
+      idProduct = "320d"; # Change according to the guide above
-  '';
+    in
+     ''
+      SUBSYSTEM=="usb", ATTR{idVendor}=="${idVendor}", MODE="[]", GROUP="adbusers", TAG+="uaccess"
+      SUBSYSTEM=="usb", ATTR{idVendor}=="${idVendor}", ATTR{idProduct}=="${idProduct}", SYMLINK+="android_adb"
+      SUBSYSTEM=="usb", ATTR{idVendor}=="${idVendor}", ATTR{idProduct}=="${idProduct}", SYMLINK+="android_fastboot"
+    '';
    # add user to adbusers group
@@ Line 257: / Line 280: @@
 }
 </syntaxhighlight>
 # [https://nixos.org/nix-dev/2015-April/016881.html more information on that snippet]
 # [https://gist.github.com/Nadrieril/d006c0d9784ba7eff0b092796d78eb2a A shell.nix to build LineageOS]
@@ Line 262: / Line 286: @@
 # [https://github.com/mrVanDalo/LineagoOS-build LineageOS build setup using terranix and hcloud], based on the [https://gist.github.com/Nadrieril/d006c0d9784ba7eff0b092796d78eb2a shell.nix to build LineageOS]. Useful if you are in a rush and don't have to much CPU power on your hand.
 # [https://wiki.archlinux.org/title/Android_Debug_Bridge Archlinux Wiki to Android_Debug_Bridge]
+[[Category:Development]]