Skip to content

Commit

Permalink
Update built_apps/README.md and delete tar.gz files
Browse files Browse the repository at this point in the history
  • Loading branch information
dapplegatecp committed Dec 23, 2023
1 parent 1e2cb34 commit 5541625
Show file tree
Hide file tree
Showing 39 changed files with 25 additions and 4 deletions.
Binary file removed built_apps/5GSpeed.tar.gz
Binary file not shown.
Binary file removed built_apps/AutoInstall.tar.gz
Binary file not shown.
Binary file removed built_apps/Boot2.tar.gz
Binary file not shown.
Binary file removed built_apps/Installer_UI.tar.gz
Binary file not shown.
Binary file removed built_apps/Mobile_Site_Survey.tar.gz
Binary file not shown.
Binary file removed built_apps/OBDII_monitor.tar.gz
Binary file not shown.
29 changes: 25 additions & 4 deletions built_apps/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Built Apps
These files are sample SDK Applications that are ready to use for testing and do not require modification or "building" of the app from source files.

## How to use these files: ##
Expand All @@ -13,14 +12,26 @@ https://customer.cradlepoint.com/s/article/NetCloud-Manager-Tools-Tab#sdk_apps

- **5GSpeed**
- Run Ookla speedtests via NCM API. Results are put in asset_id field (configurable in SDK Data). Clearing the results starts a new test. This can be done easily via NCM API v2 /routers/ endpoint.
- **app_template_csclient**
- A template for the creation of a new application utilizing the csclient library.
- **app_holder**
- Just a holder for dynamic_app. See dynamic_app.
- **Autoinstall**
- Automatically choose fastest SIM on install. On bootup, AutoInstall detects SIMs, and ensures (clones) they have unique WAN profiles for prioritization. Then the app collects diagnostics and runs Ookla speedtests on each SIM. Then the app prioritizes the SIMs WAN Profiles by TCP download speed. Results are written to the log, set as the description field, and sent as a custom alert. The app can be manually triggered again by clearing out the description field in NCM.
- **Installer_UI**
- Provide a web interface for installers to configure WiFi and run speedtests.
- **Mobile_Site_Survey**
- Robust Site Survey app with cloud aggregating and reporting via 5g-ready.io
- **cp_shell_**
- **app_template_csclient**
- A template for the creation of a new application utilizing the csclient library.
- **cp_shell**
- Web interface for running linux shell commands.
- **cli_sample**
- Includes csterm module that enables access to local CLI to send commands and return output.
- **ipverify_custom_action**
- Create a custom action in a function to be called when an IPverify test status changes.
- **dynamic_app**
- Downloads apps from a self hosted url and install into app_holder app. Overcome limitates with dev_mode and app size limits.
- **cpu_usage**
- Gets cpu and memory usage information from the router every 30 seconds and writes a csv file to a usb stick formatted in fat32.
- **ftp_client**
Expand All @@ -42,7 +53,7 @@ https://customer.cradlepoint.com/s/article/NetCloud-Manager-Tools-Tab#sdk_apps
- **ibr1700_obdII**
- Demonstrates how to access OBD-II PIDs on the IBR1700
- **logfile**
- Writes router logs to flash available for download via HTTP/NCM LAN Manager port 8000.
- Writes router logs to flash available for download via HTTP/LAN Manager.
- **mosquitto**
- Demonstrates launching embedded mosquitto server
- **mqtt_app**
Expand All @@ -56,11 +67,17 @@ https://customer.cradlepoint.com/s/article/NetCloud-Manager-Tools-Tab#sdk_apps
- **ping_sample**
- Contains ping function and example usage.
- **ports_status**
- Sets the device description to visually show the LAN/WAN/WWAN/Modem/IP Verify status
- Sets the device description to visually show the LAN/WAN/WWAN/Modem/IP Verify status.
- **python_module_list**
- This app will log the python version and modules in the device. It is intended to help with app development to show the python environment within the device.
- **shell_sample**
- Provides example how to execute commands at OS shell: "ls - al".
- **send_to_server**
- Gets the '/status' from the device config store and send it to a test server.
- **serial_temp**
- This is a test application to serial data from the data logger connected.
- **serial_vibration_test**
- This is a test developed for the Cradlepoint Serial Device (CSD) to be used during vibration testing of the CSD. The application is a simple serial echo server that opens a port on the router. Data is sent to the application and is echoed back to the client over the serial port. A LAN device is connected and communicates with the router via port 5556. When the vibration test is running, the LAN client will be notified if the serial cable is disconnected or connected.
- **simple_custom_dashboard**
- Creates a simple dashboard using HTML and JS. Note that any 'server function' requires the router firewall to be correctly changed to allow client access to the router.
- **simple_web_server**
Expand All @@ -69,6 +86,10 @@ https://customer.cradlepoint.com/s/article/NetCloud-Manager-Tools-Tab#sdk_apps
- Get various system diagnostics, alert on thresholds, and put current status in asset_id field.
- **tornado_sample**
- A webserver using Tornado with NCM-themed example to set WiFi SSIDs.
- **throttle_cellular_datacap**
- Upon *any* Modem interface reaching 100% of the monthly data capacity limit, manual QoS will be enabled globally and bandwidth throttling will be enforced on ALL Modem profiles to the configured limit (minbwup and minbwdown variables).
- **throttle_cellular_datacap_rate_tiered**
- Upon *any* Modem interface reaching 70, 80, 90 or 100% of the monthly data capacity limit, manual QoS will be enabled globally and bandwidth throttling will be enforced on ALL Modem profiles to the configured limit as set by the rate tier (minbwup and minbwdown variables).


----------
Expand Down
Binary file removed built_apps/app_template_csclient.tar.gz
Binary file not shown.
Binary file removed built_apps/cli_sample.tar.gz
Binary file not shown.
Binary file removed built_apps/cp_shell.tar.gz
Binary file not shown.
Binary file removed built_apps/cpu_usage.tar.gz
Binary file not shown.
Binary file removed built_apps/ftp_client.tar.gz
Binary file not shown.
Binary file removed built_apps/ftp_server.tar.gz
Binary file not shown.
Binary file removed built_apps/geofences.tar.gz
Binary file not shown.
Binary file removed built_apps/gpio_any_wan_connected.tar.gz
Binary file not shown.
Binary file removed built_apps/gps_probe.tar.gz
Binary file not shown.
Binary file removed built_apps/hello_world.tar.gz
Binary file not shown.
Binary file removed built_apps/hspt.tar.gz
Binary file not shown.
Binary file removed built_apps/ibr1700_gnss.tar.gz
Binary file not shown.
Binary file removed built_apps/ibr1700_obdII.tar.gz
Binary file not shown.
Binary file removed built_apps/ipverify_custom_action.tar.gz
Binary file not shown.
Binary file removed built_apps/logfile.tar.gz
Binary file not shown.
Binary file removed built_apps/mosquitto.tar.gz
Binary file not shown.
Binary file removed built_apps/mqtt_app.tar.gz
Binary file not shown.
Binary file removed built_apps/mqtt_azure_client.tar.gz
Binary file not shown.
Binary file removed built_apps/mqtt_azure_tls.tar.gz
Binary file not shown.
Binary file removed built_apps/ping_sample.tar.gz
Binary file not shown.
Binary file removed built_apps/ports_status.tar.gz
Binary file not shown.
Binary file removed built_apps/python_module_list.tar.gz
Binary file not shown.
Binary file removed built_apps/send_to_server.tar.gz
Binary file not shown.
Binary file removed built_apps/serial_temp.tar.gz
Binary file not shown.
Binary file removed built_apps/serial_vibration_test.tar.gz
Binary file not shown.
Binary file removed built_apps/shell_sample.tar.gz
Binary file not shown.
Binary file removed built_apps/simple_custom_dashboard.tar.gz
Binary file not shown.
Binary file removed built_apps/simple_web_server.tar.gz
Binary file not shown.
Binary file removed built_apps/system_monitor.tar.gz
Binary file not shown.
Binary file removed built_apps/throttle_cellular_datacap.tar.gz
Binary file not shown.
Binary file not shown.
Binary file removed built_apps/tornado_sample.tar.gz
Binary file not shown.

0 comments on commit 5541625

Please sign in to comment.