Extend your Ericsson routers with custom Python applications.
The NCOS SDK enables developers to build and deploy Python applications that run directly on Ericsson Cradlepoint NetCloud OS (NCOS) routers. Create custom logic for connectivity management, IoT data collection, monitoring, automation, and more—without replacing hardware.
Pre-built application packages (.tar.gz) ready to install on your router are available at:
These are compiled from the sample apps in this repository and can be installed via NetCloud Manager's Tools page without any development setup.
| Resource | Link |
|---|---|
| SDK Developer Guide | docs/NCOS_SDK_Developer_Guide.md |
| cp.py Methods Reference | docs/cp_methods_reference.md |
| NetCloud Manager — SDK apps | Tools Tab |
| Third-Party Licenses | THIRD-PARTY-LICENSES.md |
├── apps/ # Sample applications, and where your new apps are created
│ ├── 5GSpeed/ # Each app is a self-contained folder
│ ├── hello_world/ # with package.ini, start.sh, readme.md, etc.
│ ├── mqtt_app/
│ ├── ... # 75+ apps total
│ ├── templates/ # app_template, web_app_template
│ └── archive/ # Retired/inactive apps
├── docs/ # API documentation
├── make.py # Build/deploy tool
└── sdk_settings.ini # Router connection settings
Apps are categorized using the tags field in their package.ini (e.g., tags = connectivity, speedtest).
Prerequisites
- Python 3.9 or higher — Windows users, see the Windows Python Setup Guide
- Git (optional, for cloning the repository)
- A router with Developer Mode enabled in NetCloud Manager (Tools > Developer Mode Devices)
Clone this repo directly — no fork needed. git pull then always brings you the latest
samples, with no fork to keep in sync first. If you later decide to contribute an app back,
you create the fork at that point: see
Contributing back upstream.
-
Have Git installed? In Kiro, open the Command Palette and select Git: Clone, then paste this repo's URL:
https://github.com/cradlepoint/sdk-samples.gitKiro clones the repo and opens it for you.
No Git? Download a ZIP instead:
- On this repo's GitHub page, click the green Code button, then Download ZIP
- Extract the ZIP to a folder on your computer
- In Kiro, use File > Open Folder (or the Command Palette's File: Open Folder) and
select the extracted
sdk-samplesfolder
Once the repo is open in Kiro, open the chat panel — that's it. Kiro builds the .venv
environment and installs dependencies automatically the first time a session starts, then
asks in chat for your router details. Nothing to click. Then just describe the app you want —
see docs/SETUP.md.
If you'd rather set things up from a terminal instead of letting Kiro do it:
git clone https://github.com/cradlepoint/sdk-samples.git
cd sdk-samplesmacOS / Linux:
python3 setup_env.pyWindows:
python setup_env.pysetup_env.py does the whole setup:
- creates the
.venvvirtual environment - installs everything in
requirements.txt - prompts for your dev-mode router IP, username, and password and writes them to
sdk_settings.ini(press Enter or typeskipto leave it for later) - confirms the router is reachable and Developer Mode is on
- points the IDE's Python interpreter at
.venv
Useful flags:
| Flag | Effect |
|---|---|
--configure |
Only update the router settings |
--skip-router |
Only build the venv and install dependencies |
-y |
Never prompt (CI, hooks) |
--quiet |
Print only problems and changes |
--hook |
Session-start mode used by Kiro: fixes the environment, prints one status line, always exits 0 |
--router-ip / --router-username / --router-password |
Set settings without prompting |
setup_env.py writes these for you. To edit them by hand, open sdk_settings.ini:
[sdk]
app_name=hello_world
dev_client_ip=192.168.0.1
dev_client_username=admin
dev_client_password=your_passwordsdk_settings.ini holds credentials, so it is git-ignored and never committed.
You do not need to create it: setup_env.py and make.py both generate it from
sdk_settings.ini.example the first time they run.
If you cloned this repo before the file was git-ignored, untrack your local copy once:
git rm --cached sdk_settings.ini# Create a new app (created in apps/, path printed when done)
python3 make.py create my_app
# Build a single app (searches apps/ recursively)
python3 make.py build my_app
# Build all apps
python3 make.py build all
# Deploy to connected router (purge + build + install + start)
python3 make.py deploy my_app
# Check status
python3 make.py status my_app| Action | Description |
|---|---|
| create | Scaffold a new app from app_template into apps/<name>/ |
| build | Package an app as .tar.gz for deployment |
| deploy | Full lifecycle: purge → build → install → verify |
| status | Show app state on the connected router |
| start / stop | Control a running app |
| uninstall | Remove app from router |
| clean | Remove local build artifacts |
| contribute | Fork, branch, commit, push, and open a PR for one app |
Built something worth sharing? You fork only when you reach this point, and you add the fork
as a second remote so origin keeps pointing at this repo. That way git pull still works
exactly as before.
One command does all of it:
# macOS / Linux
.venv/bin/python3 make.py contribute my_app
# Windows
.venv\Scripts\python make.py contribute my_appIt walks through the whole flow and stops for confirmation before anything is committed:
- Checks your app the way CI does — it needs a
readme.md, and itspackage.inineeds a[section]header matching the folder name. - Creates a branch from the current upstream
master. - Shows exactly which files it is about to commit and asks you to confirm. Only your app's
folder is staged. Build artifacts,
METADATA/, andsdk_settings.iniare git-ignored and never included. - Asks for a commit message, then commits.
- Creates your fork if you don't have one, adds it as a remote named
fork, and pushes the branch there.originis left pointing at this repo, sogit pullkeeps working. - Asks for a pull request title and description, then opens the PR.
Nothing touches your GitHub account until after you've approved the commit. If you stop partway, your work is committed on the branch and the command tells you how to finish by hand.
First run only: contributing needs the GitHub CLI to create the
fork, authenticate the push, and open the PR. If you don't have it, contribute offers to
download it into .gh/ — about 10 MB, no admin rights needed, and it stays inside the repo
folder. You then sign in to GitHub once with a one-time code in your browser. Later runs skip
both steps. Decline the download and contribute falls back to doing the fork and PR through
your browser instead.
If you'd rather run the git commands yourself:
# 1. Fork on github.com, then add it as a second remote
git remote add fork https://github.com/YOUR-USERNAME/sdk-samples.git
# 2. Branch, commit just your app, and push to your fork
git fetch origin
git checkout -b add-your_app origin/master
git add apps/your_app
git commit -m "Add your_app"
git push -u fork add-your_appThen open the pull request from the link in the git push output. Check the two CI
requirements above before you submit.
This whole section is optional — your clone works completely on its own for building and deploying apps to your router.
This Software Development Kit License Agreement (this "Agreement") is entered into by and between Ericsson Enterprise Wireless Solutions, Inc. ("Company"), and the individual or entity that downloads, installs, or uses the SDK ("You" or "Licensee"). By downloading, installing, accessing, or using the SDK, You agree to be bound by this Agreement. If You are accepting on behalf of an entity, You represent that You have authority to bind that entity.
License. Company grants You a limited, non-exclusive, non-transferable, non-sublicensable, revocable license during the term to: (a) install and use the SDK internally to develop, test, and support applications that interoperate with the Service ("Applications"); and (b) distribute the SDK's redistributable runtime components, if any and only as expressly designated as redistributable in the documentation, solely as incorporated into and as necessary to run Your Applications. You will not, and will not permit any third party to: (a) reverse engineer, decompile, or disassemble the SDK, except to the extent this restriction is prohibited by applicable law; (b) modify, translate, or create derivative works of the SDK, except as expressly permitted for redistributable components; (c) rent, lease, sell, sublicense, or distribute the SDK except as expressly permitted; (d) use the SDK to build a product or service that competes with the Service or the SDK; (e) remove or alter any proprietary notices; or (f) use the SDK other than to develop and support Applications that interoperate with the Company’s services.
Limitations. Company has no obligation under this Agreement to provide support, maintenance, updates, or upgrades for the SDK. Company may modify, deprecate, or discontinue the SDK or any feature at any time. THE SDK IS PROVIDED "AS IS" AND "AS AVAILABLE," WITHOUT WARRANTY OF ANY KIND. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, COMPANY DISCLAIMS ALL WARRANTIES, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, AND ANY WARRANTY ARISING FROM COURSE OF DEALING OR USAGE OF TRADE. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, COMPANY WILL NOT BE LIABLE FOR ANY INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, OR EXEMPLARY DAMAGES, OR FOR LOST PROFITS, REVENUE, DATA, OR GOODWILL, ARISING OUT OF OR RELATED TO THIS AGREEMENT OR THE SDK, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. COMPANY'S TOTAL AGGREGATE LIABILITY ARISING OUT OF OR RELATED TO THIS AGREEMENT WILL NOT EXCEED USD $100. This Agreement is effective until terminated. Company may terminate this Agreement immediately if You breach it. You may terminate at any time by ceasing all use of the SDK and destroying all copies. Upon termination, the licenses herein end and You will cease using and destroy all copies of the SDK.