ics-wivi-analytics-ingest 0.1.1__py3-none-any.whl → 0.1.2__py3-none-any.whl

analytics_ingest/internal/schemas/ingest_config_schema.py

@@ -24,7 +24,5 @@ class IngestConfigSchema(BaseModel):
     @model_validator(mode="after")
     def validate_env_or_param(self):
         if not self.graphql_endpoint:
-            raise ValueError(
-                "Missing GraphQL endpoint. Set via param or GRAPH_ENDPOINT env."
-            )
+            self.graphql_endpoint = "https://0.0.0.0:8092/graphql"
         return self

{ics_wivi_analytics_ingest-0.1.1.dist-info → ics_wivi_analytics_ingest-0.1.2.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: ics-wivi-analytics-ingest
-Version: 0.1.1
-Summary: - JWT token added in the header.
+Version: 0.1.2
+Summary: - README Updated.
 Author-email: Haseeb Saif Ullah <hsaif@intrepidcs.com>, Scott VanDeWater <svandewater@intrepidcs.com>
 License: Copyright (c) 2018-2025 Intrepid Control Systems, Inc.
         
@@ -74,9 +74,19 @@ A lightweight Python library to batch and send automotive telemetry — like sig
 ```bash
 pip install ics-wivi-analytics-ingest
 ```
-
 ---
 
+## 🔑 Setting JWT & Endpoint via Environment Variables
+
+You can avoid hardcoding sensitive values like JWT tokens and GraphQL endpoints by using environment variables.
+
+### Example (Linux / macOS)
+
+```bash
+export SEC_AUTH_TOKEN="your-jwt-token-here"
+export GRAPHQL_ENDPOINT="https://0.0.0.0:8092/graphql"
+```
+
 ## 🚀 Quick Usage
 
 ```python
@@ -87,7 +97,8 @@ client = IcsAnalytics(
     vehicle_id=456,
     fleet_id=789,
     org_id=1011,
-    graphql_endpoint="https://your-backend/graphql",
+    graphql_endpoint="https://0.0.0.0:8092/graphql", #default endpoint
+    jwt_token="token",
     batch_size=100,
     batch_interval_seconds=10,
     max_signal_count=100
@@ -128,6 +139,10 @@ client.add_dtc({
         'description': 'Head-Up Display - Internal Electronic Failure',
         'status': '2F',
         'time': '2025-07-15T01:42:15.979524'
+        'extended':[{'bytes':'3214"31241234123412'} # more bytes
+        ]
+        'snapshot':[{'bytes':'3214"31241234123412'} # more bytes
+        ]
     }, # more data objects. 
     ]
 })
@@ -151,17 +166,6 @@ client.add_gps({
 })
 
 # Add Network Stats
-client.add_network_stats({
-    "name": "CAN1",
-    "vehicleId": 456,
-    "uploadId": 1,
-    "totalMessages": 1000,
-    "matchedMessages": 950,
-    "unmatchedMessages": 50,
-    "errorMessages": 0,
-    "longMessageParts": 0,
-    "rate": 500.0
-})
 
 client.add_network_stats({
     'name': 'jacobs',
@@ -198,6 +202,98 @@ Set through constructor or environment variables.
 | `batch_size`             | Max items per batch       | 100     |
 | `batch_interval_seconds` | Time-based flush interval | 10      |
 | `max_signal_count`       | Max signals before flush  | 100     |
+| `jwt_token`              | JWT token                 | ''      |
+
+
+---
+
+---
+
+### 🔧 Payload Reference
+
+#### `add_signal` Payload
+
+| Key           | Description                        | Required / Optional |
+| ------------- | ---------------------------------- | ------------------- |
+| `name`        | Signal name                        | **Required**        |
+| `unit`        | Measurement unit (e.g. °C, km/h)   | **Required**        |
+| `messageName` | Message name in DB                 | **Required**        |
+| `networkName` | Network name                       | **Required**        |
+| `ecuName`     | ECU name                           | Optional            |
+| `arbId`       | Arbitration ID                     | Optional            |
+| `fileId`      | File ID for trace reference        | **Required**        |
+| `paramType`   | Parameter type (`TEXT`, `NUMBER`, `ENCODED`, `RAW`, `STRING`) | Optional            |
+| `signalType`  | Signal type (`DID`, `PID`, `DMR`, `SIGNAL`)| Optional    |
+| `messageDate` | Message timestamp (ISO 8601)       | **Required**        |
+| `paramId`     | Parameter ID (DID identifier)      | Optional            |
+| `data`        | List of data objects               | **Required**        |
+
+**Inside `data`:**
+
+| Key      | Description               | Required / Optional |
+| -------- | ------------------------- | ------------------- |
+| `value`  | Numeric value             | Optional            |
+| `time`   | Timestamp (ISO 8601)      | **Required**        |
+| `svalue` | String value (if textual) | Optional            |
+
+---
+
+#### `add_dtc` Payload
+
+| Key           | Description                  | Required / Optional |
+| ------------- | ---------------------------- | ------------------- |
+| `messageName` | DTC message name             | **Required**        |
+| `name`        | DTC display name             | Optional            |
+| `networkName` | Network name                 | **Required**        |
+| `ecuName`     | ECU name                     | Optional            |
+| `ecuId`       | ECU ID                       | Optional            |
+| `messageDate` | Message timestamp (ISO 8601) | Optional            |
+| `fileId`      | File ID for trace reference  | Optional            |
+| `data`        | List of DTC data objects     | **Required**        |
+
+**Inside `data`:**
+
+| Key           | Description                | Required / Optional |
+| ------------- | -------------------------- | ------------------- |
+| `dtcId`       | DTC identifier             | **Required**        |
+| `description` | Human-readable description | **Required**        |
+| `status`      | Status code                | **Required**        |
+| `time`        | Timestamp (ISO 8601)       | **Required**        |
+| `extended`    | List of bytes's objects    | Optional            |
+| `snapshot`    | List of bytes's objects    | Optional            |
+
+---
+
+#### `add_gps` Payload
+
+| Key         | Description                        | Required / Optional |
+| ----------- | ---------------------------------- | ------------------- |
+| `time`      | Timestamp (ISO 8601)               | **Required**        |
+| `latitude`  | Latitude                           | Optional            |
+| `longitude` | Longitude                          | Optional            |
+| `accuracy`  | GPS accuracy (meters)              | Optional            |
+| `altitude`  | Altitude (meters)                  | Optional            |
+| `speed`     | Speed (m/s or chosen unit)         | Optional            |
+| `bearing`   | Bearing (degrees)                  | Optional            |
+| `available` | Object describing available fields, all of them are optional | Optional |
+
+---
+
+#### `add_network_stats` Payload
+
+| Key                 | Description              | Required / Optional |
+| ------------------- | ------------------------ | ------------------- |
+| `name`              | Network name             | **Required**        |
+| `vehicleId`         | Vehicle ID               | **Required**        |
+| `uploadId`          | Upload session ID        | **Required**        |
+| `totalMessages`     | Total number of messages | **Required**        |
+| `matchedMessages`   | Number of matched msgs   | **Required**        |
+| `unmatchedMessages` | Number of unmatched msgs | **Required**        |
+| `errorMessages`     | Number of errors         | **Required**        |
+| `longMessageParts`  | Number of long msgs      | **Required**        |
+| `rate`              | Message rate             | **Required**        |
+| `maxTime`           | Max timestamp (ISO 8601) | Optional            |
+| `minTime`           | Min timestamp (ISO 8601) | Optional            |
 
 ---
 

{ics_wivi_analytics_ingest-0.1.1.dist-info → ics_wivi_analytics_ingest-0.1.2.dist-info}/RECORD

@@ -5,7 +5,7 @@ analytics_ingest/internal/schemas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeR
 analytics_ingest/internal/schemas/configuration_schema.py,sha256=u53vkAPBjEI6orcIxapiD983VrytyrSz1ZfwCymMvhc,451
 analytics_ingest/internal/schemas/dtc_schema.py,sha256=l-XeV0zj8fMwfbJH_V7SF29di4wBoMlglLwCer0tEmQ,491
 analytics_ingest/internal/schemas/gps_schema.py,sha256=4h7yvL8rf8jk_zdHvrCMjoVz6deidcGUvGASMMSrSdg,919
-analytics_ingest/internal/schemas/ingest_config_schema.py,sha256=4h3SMVrSljunh29ClTGQU7D8LuQEZWs1Fsstlpe34J8,946
+analytics_ingest/internal/schemas/ingest_config_schema.py,sha256=KyBLJKdK492KDmDiK4EZhf3UZVDFJkXMQE8r74OIWik,888
 analytics_ingest/internal/schemas/message_schema.py,sha256=dtNwwjxVE0NHrsoJDiveKjus_ENZVyWj0guAGDlrW1Q,979
 analytics_ingest/internal/schemas/network_schema.py,sha256=d003Z5oAd5bT-KdBKBoKE0DI9owj0rR1951hrLoiml0,1023
 analytics_ingest/internal/schemas/signal_schema.py,sha256=vRklzKC4gaAnk-q8iafnPqP2Ch3NjpKKLW9GMK6ZA9U,3179
@@ -28,8 +28,8 @@ factories/init_schema_factory.py,sha256=1EnCD_IHoKTER2X6gbug0ZUsr9Iho9t3bbgABwLH
 factories/message.py,sha256=C7JorFPIrFzBSfsmRP2pIQ6MKS-1H9imDhm0PMe1YSc,722
 factories/network_stats.py,sha256=HCttDWOXPUDqJnh66DuwbtJEQmUzrPGYHmaxCVD6Bvo,813
 factories/signal.py,sha256=zsj1p13dbKDStNhW0GHOOf8Ru8bM-VHV1pW1mj5ZZFs,1513
-ics_wivi_analytics_ingest-0.1.1.dist-info/licenses/LICENSE,sha256=y8iihD3bEcObJaLI4FUKuGXa0Yr3BnOmQ3QUPuPvO90,1649
-ics_wivi_analytics_ingest-0.1.1.dist-info/METADATA,sha256=ZtyNII5ARbXiFa1q4zgSgXPRBi3BceweYW35vkIkkSo,7693
-ics_wivi_analytics_ingest-0.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ics_wivi_analytics_ingest-0.1.1.dist-info/top_level.txt,sha256=SSaHIk3V55_kvJGdVYLZUIP5tJVdSibTLt1rFtqKN00,27
-ics_wivi_analytics_ingest-0.1.1.dist-info/RECORD,,
+ics_wivi_analytics_ingest-0.1.2.dist-info/licenses/LICENSE,sha256=y8iihD3bEcObJaLI4FUKuGXa0Yr3BnOmQ3QUPuPvO90,1649
+ics_wivi_analytics_ingest-0.1.2.dist-info/METADATA,sha256=sXAQ9qMjDlzM8bl78me40jCpW4dUASoOcvw-4Gh2yA8,12609
+ics_wivi_analytics_ingest-0.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ics_wivi_analytics_ingest-0.1.2.dist-info/top_level.txt,sha256=SSaHIk3V55_kvJGdVYLZUIP5tJVdSibTLt1rFtqKN00,27
+ics_wivi_analytics_ingest-0.1.2.dist-info/RECORD,,