https://github.com/ixoncloud/edge-app-gps-data-logger
Edge App - GPS Data Logger for SecureEdge Pro
https://github.com/ixoncloud/edge-app-gps-data-logger
Last synced: 9 months ago
JSON representation
Edge App - GPS Data Logger for SecureEdge Pro
- Host: GitHub
- URL: https://github.com/ixoncloud/edge-app-gps-data-logger
- Owner: ixoncloud
- License: mit
- Created: 2025-08-07T14:40:00.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-08-20T09:31:02.000Z (10 months ago)
- Last Synced: 2025-08-20T11:32:20.607Z (10 months ago)
- Language: JavaScript
- Size: 281 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Edge App - GPS Data Logger for SecureEdge Pro
This project provides a ready-to-deploy solution for logging GPS data on IXON's SecureEdge Pro device (**Cellular** and **Combi** variants only). It uses Node-RED to collect GPS data and send it to IXON Cloud via the Plain-text TCP protocol.
> **Note:** This solution is only available on SecureEdge Pro devices with cellular or combi modules. It requires an open sky environment and a connected GPS antenna.
## Features
- Collects real-time GPS data from SecureEdge Pro hardware
- Node-RED flows for data processing and sending data via Plain-text TCP
- Seamless integration with IXON Cloud for remote monitoring and logging
- Docker-based deployment for easy installation and updates
## Prerequisites
- SecureEdge Pro (Cellular or Combi variant)
- **Firmware version 5.7 or higher is required**
- GPS antenna connected and device placed with open sky access
- IXON Cloud account
- Access to the SecureEdge Pro local web interface
- Ensure your environment is properly set up by following this guide: [Running custom Docker applications on the SecureEdge Pro](https://support.ixon.cloud/s/article/Running-custom-Docker-applications-on-the-SecureEdge-Pro).
## Quick Start
### 1. Download and Adjust to Your SecureEdge Pro
- Download or clone this project to your local machine.
- If you do not use the default LAN IP address for your SecureEdge Pro, update the IP address in the following files to match your device's LAN IP:
- `buildkitd-secure-edge-pro.toml`
- `build_and_push_containers.sh`
- `build_and_push_containers.cmd`
- `node-red/flows.json`
### 2. Build and Push Containers
- For Unix-based systems:
```bash
./build_and_push_containers.sh
```
- For Windows:
```cmd
build_and_push_containers.cmd
```
### 3. Deploy on SecureEdge Pro
1. Access the SecureEdge Pro local web interface.
2. Create and configure a new container for Node-RED:
- **Image:** Use the Node-RED image provided in this project (`node-red-gps-logger`)
- **Port mapping:** `1880:1880`
- **Volume:** `node_red_data` → `/data`
Refer to the screenshot below for the correct container setup:
3. Start the container and access the Node-RED web interface (via IXON Cloud HTTP Web Server or local network).
4. Open the Node-RED flow and ensure it:
- Collects GPS data from the hardware
- Establishes a TCP connection to the edge gateway on port `9230`
- Uses the same addresses as configured in IXON Cloud variables
### 4. Access Node-RED
- In IXON Cloud, create an HTTP Web Server to access the Node-RED web interface.
- Open Node-RED and log in using the default credentials:
- **Username:** `admin`
- **Password:** `password`
- Review or adjust the flow for GPS data collection and transmission.
> **Security Note:** For production use, it's highly recommended to change the default password. See the [Node-RED Authentication](#node-red-authentication) section below for instructions.
### 5. Configure IXON Cloud: Data Source and Variables
#### a. Add a Plain-text TCP Data Source
1. In IXON Cloud, go to your device and add a new data source of type **Plain-text TCP**.
2. Enter a name (e.g., `GPS Logger`).
3. Leave the IP address empty.
4. Set a password (at least 6 characters) — The Node-RED flow uses 123456 as default password in the Build DEVC Line node. These passwords must match.
5. (Optional) Set polling sleep time (e.g., 100ms) and error grace period as needed.
6. Click **Add** to create the data source.
Refer to the screenshot below for the correct data source setup:
#### b. Add Variables via CSV Import
1. Under your new data source, go to **Variables**.
2. Click **Import from CSV-file** (top right).
3. Use the provided CSV file: `ixon_cloud_settings/logger-api_variables.csv` to import all required variables for GPS logging (e.g., `latitude`, `longitude`, `altitude`, etc.).
4. Review the imported variables and their addresses. Make sure these match the addresses used in your Node-RED flow.
5. Click **Push config to device** to activate the changes.
Refer to the screenshot below for the correct variable import setup:
### 6. Test and Visualize GPS Data
- In IXON Cloud, use the **Run test** feature on your data source to verify that data is being received from Node-RED.
- Use IXON Cloud dashboards to visualize and analyze the logged GPS data in real time or historically.
## Troubleshooting
- Ensure the GPS antenna is properly connected and the device has a clear view of the sky.
- Only Cellular and Combi variants of SecureEdge Pro support GPS logging.
- For further help, consult the [IXON Support Portal](https://support.ixon.cloud/).
## Node-RED Authentication
### Default Credentials
The Node-RED instance comes with authentication enabled using these default credentials:
- **Username:** `admin`
- **Password:** `password`
### Changing the Default Password
For security reasons, it's strongly recommended to change the default password, especially for production deployments.
#### Method 1: Using node-red-admin (Recommended)
1. Install Node-RED locally on your development machine:
```bash
npm install -g node-red node-red-admin
```
2. Generate a new password hash:
```bash
node-red-admin hash-pw
```
Enter your desired password when prompted. This will output a bcrypt hash.
3. Edit the `node-red/settings.js` file in this project and replace the password hash:
```javascript
adminAuth: {
type: 'credentials',
users: [
{
username: 'admin',
password: 'YOUR_NEW_HASH_HERE',
permissions: '*',
},
],
},
```
4. Rebuild and redeploy the container using the build scripts.
#### Method 2: Online Bcrypt Generator
If you prefer not to install Node-RED locally:
1. Use an online bcrypt hash generator (ensure it uses cost factor 8 or higher)
2. Generate a hash for your desired password
3. Replace the hash in `node-red/settings.js` as shown above
4. Rebuild and redeploy the container
> **Important:** After changing the password, you'll need to rebuild the Docker container and redeploy it to your SecureEdge Pro device for the changes to take effect.
## License
See [LICENSE.md](LICENSE.md) for license information.