Skip to main content
Version: v3

1. Environmental Preparation

In this section, we will complete the following environment preparations.

  • Node.js (v >= 16.0)
  • npm
  • Zeus CLI
  • TUN/TAP Network for simulator

We provide two ways to prepare the environment. We recommend using the env-setup-script provided by Zepp OS for one-click installation, or following the documentation to prepare the environment manually.

Install the environment using the env-setup-script script​

Download the env-setup-script project​

The developer downloads the corresponding installation packages according to different operating systems.

Executing script​

During this phase, the procedure varies depending on the operating system being used. Therefore, please refer to the relevant sections for your specific operating system.

Execute the script, you can complete the installation of the environment, when the script appears the following prompt indicates that the installation is successful.

Environment

Windows​

In Windows, it is recommended to use the built-in PowerShell terminal to execute commands as an administrator.

Go to the /win10-11 directory and execute the . \env-helper.ps1 command.

.\env-helper.ps1
info

If you encounter an error message like this.

File .\env-helper.ps1 cannot be loaded because running scripts is disabled on this system. For more information, see about_Execution_Policies at http://go.microsoft.com/fwlink/?LinkID=135170.

+ CategoryInfo : SecurityError: (:) [], ParentContainsErrorRecordException
+ FullyQualifiedErrorId : UnauthorizedAccess

The script doesn’t run because the PowerShell Execution Policy is set to the default of Restricted.

Please execute the following command in the terminal first:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned

And then run the script again.

macOS​

caution

If you are using a Mac with an Apple chip, this script is not applicable. Please refer to Manual Installation.

How to know if a Mac is equipped with an Apple chip?

  1. Click the Apple icon in the upper left corner of the desktop
  2. Select About This Mac
  3. In the “Overview” tab, look for “Processor” or “Chip”. Check if it says “Apple”

If the installation script has already been executed, you need to execute the following command to uninstall the relevant files, and then proceed directly to the final step of manual installation, Simulator - Installation and Startup.

sudo rm -rf /Library/Extensions/tun.kext
sudo rm -rf /Library/Extensions/tap.kext

sudo rm -f /Library/LaunchDaemons/*tun.plist
sudo rm -f /Library/LaunchDaemons/*tap.plist

In macOS, it is recommended to use the built-in Terminal or iTerm2 to execute commands.

Go to the /macOS directory and execute the script.

cd macOS
bash env-helper.sh
info
  • If prompted for a password, enter the current user's password and confirm it.
Extension with identifiers xxxxxx not approved to load. Please approve using System Preferences.
  • If you get this error, manually grant permissions in Privacy and Security in System Preferences.

Debian​

We only provide installation script for Debian-based which use apt. If you want to use it with other Linux distribution, you can see Manual Installation

In Ubuntu, it is recommended to use the built-in Terminal terminal to execute commands.

Go to the /linux directory and execute the script.

cd linux
bash env-helper.sh

Manual Installation​

Please refer to the following documents to complete the environment preparation.