# ncs_install

**Repository Path**: XiaoPb/ncs_install

## Basic Information

- **Project Name**: ncs_install
- **Description**: ncs安装脚本，包含各种依赖工具
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-01-14
- **Last Updated**: 2025-05-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ncs_install

#### 介绍
ncs安装脚本，包含各种依赖工具


#### 安装教程

##### 配置winget和脚本运行环境【可选】

系统未安装Git和VSCode时，会自动使用winget进行安装。

winget的Git安装源是github，可能需要科学上网才能正常安装，建议自行安装Git后再使用脚本安装NCS。


``` powershell
# 需要以管理员身份运行 PowerShell
# 修改脚本运行权限
Set-ExecutionPolicy RemoteSigned
# winget 配置国内源
Invoke-Expression (New-Object System.Net.WebClient).DownloadString('https://gitee.com/XiaoPb/ncs_install/raw/master/winget_config.ps1')
```

##### 配置NCS SDK安装路径【可选】

NCS SDK安装路径优先级："nrfutil toolchain-manager config" > "$env:NCS_SDK_DIR" > default("D:\NCS")

未指定时默认安装路径为 "D:\NCS"

``` powershell
# 指定NCS安装路径：以"E:\Nordic\NCS"路径为例
$env:NCS_SDK_DIR="E:\Nordic\NCS"
```

如使用 "nrfutil toolchain-manager config --set install-dir={ncs_path} " 设置过安装路径，则以上的设置无效。
注意：首次安装无法直接使用nrfutil命令！

###### 离线下载SDK

离线方式下载了NCS SDK，请先解压到指定的安装路径下（以"D:\NCS"为例）：
SDK的名字和路径都需要保持规范，（以"v2.9.1"版本为例）：

``` powershell
D:\NCS
|-- downloads
|-- toolchains
|-- v2.9.1
|   |-- bootloader
|   |-- modules
|   |-- nrf
|   |-- nrfxlib
|   |-- test
|   |-- tools
|   `-- zephyr
```

##### 配置NCS SDK安装版本【可选】

未指定时，默认安装最新版本编译链环境。

``` powershell
# 指定NCS安装版本路径：以"v2.9.1"路径为例
$env:NCS_SDK_VERSION="v2.9.1"
```

##### 安装NCS SDK依赖工具、工具链和SDK

方式一：
``` powershell
Invoke-Expression (New-Object System.Net.WebClient).DownloadString('https://gitee.com/XiaoPb/ncs_install/raw/master/ncs_install.ps1')
```

短链支持：

``` powershell
Invoke-Expression (New-Object System.Net.WebClient).DownloadString('https://ncs.xiaopb.cn')
```


方式二：
``` powershell
irm https://gitee.com/XiaoPb/ncs_install/raw/master/ncs_install.ps1 | iex
```

短链支持：

``` powershell
irm https://ncs.xiaopb.cn | iex
```

###### 脚本运行部分log：（中文版）


``` powershell
 ============================================================
 ================= 安装NCS SDK的前期准备事项 ================
 ============================================================
 =================    请先安装VSCode和Git   =================
  VSCode: https://code.visualstudio.com/
  Git: https://git-scm.com/

 ================ 请将离线SDK解压到NCS安装目录 ================
  离线NCS SDK下载链接: https://mkay2npdwd.feishu.cn/docx/QC6Ad6hdcohqVixR9IkcZesCnod?from=from_copylink

  未提前将离线SDK解压到NCS安装目录，脚本会自动从github拉取安装，需要能稳定访问GitHub的网络
  无稳定访问GitHub的网络，建议先离线下载并解压SDK到NCS安装目录

 ====== SDK解压后目录需要符合以下规范 (以NCS_SDK_DIR为"D:NCS", NCS_SDK_VERSION为"v2.9.0") ======
    D:\NCS
    |
    |-- toolchains
    | |-- b620d30767
    | `-- toolchains.json
    |
    |-- v2.9.0
    | |-- bootloader
    | |-- modules
    | |-- nrf
    | |-- nrfxlib
    | |-- test
    | |-- tools
    | `-- zephyr


 ====== 完成以上准备后，回车进行下一步 ======

NCS_SDK_DIR is already set to: D:\NCS
NCS_SDK_VERSION is already set to: v2.9.1
 ====== 检查是否有默认安装路径 ======
NCS_SDK_DIR change to E:\Code\NCS
 ====== 当前将使用以下变量值进行安装NCS ======
NCS_SDK_DIR: E:\Code\NCS
NCS_SDK_VERSION: v2.9.1
 ====== 不需要更改安装变量则按回车键使用当前值 ======
请输入新的 NCS_SDK_DIR (E:\Code\NCS):

当前NCS SDK的最新稳定版本为：v2.9.1
请输入新的 NCS_SDK_VERSION (v2.9.1):

 ====== 最终使用的变量值： ====== 
NCS_SDK_DIR: E:\Code\NCS
NCS_SDK_VERSION: v2.9.1
按回车键继续执行脚本...

```

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)