Merge pull request #734 from TarikSefer/TSE

Added Connector help pages for ISS Tracker

Author: MariekeGO

connector/doc/ISS_Tracker.md

@@ -0,0 +1,44 @@
+---
+uid: Connector_help_ISS_Tracker
+keywords: ISS, International Space Station, Tracker
+---
+
+# ISS Tracker
+
+## About
+
+The ISS Tracker connector provides real-time tracking and monitoring of the International Space Station (ISS). This connector integrates live positional data, crew information, and system status, enabling users to access information efficiently.
+
+The ISS Tracker module offers seamless integration with DataMiner, allowing for intuitive visualization of ISS metrics, including latitude, longitude, and current crew details. This real-time feed is essential for monitoring ISS movements and operational insights.
+
+## Key Features
+
+- **Real-time ISS position tracking**: Displays up-to-date latitude and longitude of the ISS with automatic updates.
+- **Crew information monitoring**: Retrieves and displays a list of the astronauts currently aboard the ISS and other space stations.
+- **Historical data logging**: Logs previous ISS positions, the number of people in space, and the data retrieval status for trend analysis and movement tracking.
+
+## Use Cases
+
+### Live ISS Position Tracking
+
+- **Challenge**: Space researchers require up-to-date location data of the ISS for various studies and tracking purposes.
+- **Solution**: The ISS Tracker connector fetches real-time ISS coordinates, ensuring accuracy and instant visibility.
+- **Benefit**: Users can precisely track ISS movements, supporting scientific research.
+
+### Crew Member Monitoring
+
+- **Challenge**: Keeping track of current ISS crew members.
+- **Solution**: The ISS Tracker module lists astronauts aboard the ISS and other craft, providing a centralized view within DataMiner.
+- **Benefit**: Users gain immediate access to crew information without needing to refer to multiple sources.
+
+## Technical Information
+
+### Prerequisites
+
+- DataMiner 10.3.0 or higher.
+- Internet connectivity for retrieving real-time ISS data.
+
+### Notes
+
+- The connector will support additional space station tracking upon future updates.
+- For further configuration details and advanced settings, refer to the [Technical help page](xref:Connector_help_ISS_Tracker_Technical).

connector/doc/ISS_Tracker_Technical.md

@@ -0,0 +1,57 @@
+---
+uid: Connector_help_ISS_Tracker_Technical
+keywords: ISS, International Space Station, Tracker
+---
+# ISS Tracker
+
+## About
+
+The ISS Tracker connector provides real-time tracking and monitoring of the International Space Station (ISS). This connector integrates live positional data, crew information, and data retrieval status information, enabling users to access critical information efficiently.
+
+The ISS Tracker module offers seamless integration with DataMiner, allowing for intuitive visualization of ISS metrics, including latitude, longitude, and current crew details. This real-time feed is essential for monitoring ISS movements and operational insights.
+
+## Configuration
+
+### Connections
+
+#### HTTP Connection - ISS Tracker API
+
+This connector uses an HTTP connection and requires the following input during element creation:
+
+HTTP CONNECTION:
+
+- **IP address/host**: `api.open-notify.org` (Public API for real-time ISS position)
+- **IP port**: `80` (Default HTTP port)
+- **Bus address**: Not required
+
+## Stream Viewer
+
+DataMiner's Stream Viewer tool can be used to monitor HTTP traffic between the ISS Tracker connector and the external data source. The connector establishes two HTTP sessions to retrieve ISS tracking and crew information. If both sessions return the status OK with the expected response body, the connection is considered operational. Otherwise, further troubleshooting may be required to resolve connectivity or API response issues.
+
+Additionally, there is a parameter that displays the connectivity status. It can display status messages that include:
+
+- **OK**
+- **Error**
+- **API Not Responding**
+
+If any message other than OK appears, the Stream Viewer should be checked.
+
+## General Functionality
+
+The ISS Tracker connector retrieves real-time data from the API and displays it in DataMiner. The following key metrics are available:
+
+- **Latitude & Longitude**: The exact position of the ISS at any given time.
+- **Crew Information**: The current astronauts aboard the ISS and other craft.
+
+You can visualize ISS movement and view historical data for analysis.
+
+## Data Retrieval Process
+
+1. The connector sends an HTTP GET request to `api.open-notify.org`.
+1. The API responds with a JSON object containing the latitude, longitude, and timestamp.
+1. Data is parsed and displayed in a DataMiner element.
+
+## Notes
+
+- The connector is dependent on the availability of the Open Notify API.
+- Future updates may include additional space station tracking.

connector/toc.yml

@@ -5011,6 +5011,13 @@
     topicUid: Connector_help_IRT_IRPC_Series
   - name: IRT SSPA Series
     topicUid: Connector_help_IRT_SSPA_Series
+- name: ISS Tracker
+  items:
+  - name: ISS Tracker
+    topicUid: Connector_help_ISS_Tracker
+    items:
+    - name: ISS Tracker Technical
+      topicUid: Connector_help_ISS_Tracker_Technical
 - name: Itelco
   items:
   - name: Itelco DVB-T2 Modulator