Feature/initial release fixes (#6)

This branch contains a collection of fixes and documentation updates
required for the initial public release.

**Bug Fixes**
- Require Python 3.13+ across all `pyproject.toml` manifests to resolve
a `SIGKILL` crash caused by `wasmtime>=43` being incompatible with
Python 3.9
- Fix MQTT topic patterns in Python and Node loopback, speed monitor,
and vehicle examples to match the correct broker topic structure for
private/public messages
- Fix identity artifact field names in Node examples (`device_id` →
`deviceId`, `expiration_time` → `expirationTime`) for consistency with
the API
- Add `type=float` to `--lat`/`--lon` CLI arguments in Python examples
to prevent string comparison errors at runtime

**Project / Build**
- Bump version to `0.3.0` across all manifests (`VERSION`,
`CMakeLists.txt`, `pyproject.toml`, `package.json` files)
- Rename npm and Python workspace packages from `etx-starter-kit` to
`etx-sample-client`
- Add `uninstall-js` Makefile target hooked into `install-js` and
`purge`
- Add `j2735codec/package.json` and `package-lock.json`; update root
lock files
- Remove stale `.python-version` pin (`3.9`); update `uv.lock` to
reflect Python 3.13 constraint and wasmtime 43.0.0
- Update `.gitignore`: replace `certs/` with `registrations/`, add
`.claude/`

**Documentation**
- Fix all GitHub URLs from `5GRealityLab/etx-starter-kit` to
`Verizon/EdgeTransportationExchange_SampleClient`
- Update cert output path references from `certs/` to `registrations/`
across all READMEs and example run commands
- Fix typos, remove emoji from headings, and improve markdown formatting
consistency across root, `etx/`, and example READMEs
- Add usage hints clarifying that speed monitor and vehicle examples
each require a separate registration profile

Author: gytibor

.gitignore

@@ -14,6 +14,7 @@ Thumbs.db
 *.sln
 *.vcxproj
 *.user
+.claude/
 
 # --- General Build Artifacts ---
 # Catches all C++, Python, and Node build directories
@@ -82,6 +83,6 @@ yarn-error.log*
 logs/
 *.log
 config.json
-certs/
+registrations/
 
 # =============================================================================

.python-version

@@ -14,8 +14,9 @@ The official onboarding resource for Verizon Edge Transportation Exchange. This
 
 Navigate to the ***[examples](etx/examples/)*** directory or select from the following links to get started:
 
-[Python](etx/examples/python/)\
-[Node](etx/examples/node/)
+**[Python](etx/examples/python/)**
+
+**[Node](etx/examples/node/)**
 
 ## Key Features
 
@@ -51,27 +52,28 @@ The codec and language bindings can be found and installed directly from the rel
 ### Python
 
 *UV*:
+
 ```bash
-uv add "https://github.com/5GRealityLab/etx-starter-kit/releases/download/v0.0.0-alpha/python-j2735codec-0.0.0-py3-none-any.whl"
+uv add "https://github.com/Verizon/EdgeTransportationExchange_SampleClient/releases/download/v0.0.0-alpha/python-j2735codec-0.0.0-py3-none-any.whl"
 ```
 
 *Pip*:
+
 ```bash
-pip install "https://github.com/5GRealityLab/etx-starter-kit/releases/download/v0.0.0-alpha/python-j2735codec-0.0.0-py3-none-any.whl"
+pip install "https://github.com/Verizon/EdgeTransportationExchange_SampleClient/releases/download/v0.0.0-alpha/python-j2735codec-0.0.0-py3-none-any.whl"
 ```
 
 ### Node
 
-*NPM*
+*NPM*:
 
 ```bash
-npm install "https://github.com/5GRealityLab/etx-starter-kit/releases/download/v0.0.0-alpha/node-j2735codec-0.2.0.tgz"
+npm install "https://github.com/Verizon/EdgeTransportationExchange_SampleClient/releases/download/v0.0.0-alpha/node-j2735codec-0.2.0.tgz"
 ```
 
 **Note**: The release links above are not valid. Please see release page for proper links to to use. You can also download the files from the release page and install locally as well.
 
-**For more advance users and contributors**, it is possible to install these packages directly from the source tree as well. The instructions [can be found here](/j2735codec/README.md). 
-
+**For more advance users and contributors**, it is possible to install these packages directly from the source tree as well. The instructions [can be found here](/j2735codec/README.md).
 
 ## Version Management (For Contributors Only)
 
@@ -83,5 +85,6 @@ To propagate a version change from the root `VERSION` file to all sub-manifests:
 make sync-version
 ```
 
-## ⚖️ License
+## License
+
 Licensed under the Apache License 2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE) for details.

README.md

@@ -1 +1 @@
-0.2.0
+0.3.0

VERSION

@@ -1,11 +1,13 @@
 # Edge Transportation Exchange (ETX)
 
-## 🌐 Overview
-The **Edge Transportation Exchange (ETX)** is a high-performance, mobile-network-integrated V2X (Vehicle-to-Everything) communication platform. By leveraging Verizon networks alongside low-latency Mobile Edge Compute (MEC), ETX enables near-real-time bidirectional data sharing between vehicles, vulnerable road users (pedestrians and cyclists), and intelligent infrastructure. 
+## Overview
+
+The **Edge Transportation Exchange (ETX)** is a high-performance, mobile-network-integrated V2X (Vehicle-to-Everything) communication platform. By leveraging Verizon networks alongside low-latency Mobile Edge Compute (MEC), ETX enables near-real-time bidirectional data sharing between vehicles, vulnerable road users (pedestrians and cyclists), and intelligent infrastructure.
 
 Unlike traditional V2X models that rely heavily on physical roadside units (RSUs), ETX uses a virtualized architecture and a sophisticated geospatial routing engine. This engine organizes the world into high-precision **Geohashes**, ensuring that messages—from safety-critical BSMs to traffic signal timings (SPaT)—are delivered only to participants within relevant proximity, maximizing system efficiency and reducing network noise.
 
-## 🛠 Technical Specifications
+## Technical Specifications
+
 | Feature | Implementation |
 | :--- | :--- |
 | **Protocol** | MQTT 3.1.1 (v4) |
@@ -14,50 +16,55 @@ Unlike traditional V2X models that rely heavily on physical roadside units (RSUs
 | **Payload Format** | J2735 UPER wrapped in Protobuf |
 | **QoS Levels** | 0 (Preferred), 1 supported |
 
-> **For more information and API specification please visit the [link here](https://thingspace.verizon.com/documentation/api-documentation.html#/http/specialized-apis/edge-transportation-exchange/mqtt-api).**
+> **For more information and API specification please visit the [link here](https://thingspace.verizon.com/documentation/api-documentation.html#/http/specialized-apis/edge-transportation-exchange).**
 
-## 🔄 How Message Routing Works
+## How Message Routing Works
 
-Georouting in the ETX ecosystem follows a highly structured "wrapper" pipeline to balance standardized V2X intelligence with high-speed delivery. 
+Georouting in the ETX ecosystem follows a highly structured "wrapper" pipeline to balance standardized V2X intelligence with high-speed delivery.
 
 **Note: The encoding and wrapping mechanism (e.g. steps 1 and 2) is included in the language bindings.**
 
 ### 1. J2735 Encoding
+
 The process begins with a J2735 message (such as a BSM), which is encoded into a compact, binary **UPER** format using the core C++/WASM codec.
 
 ### 2. Protobuf Wrapping
+
 Because standard MQTT brokers are "location-blind," the raw binary is encapsulated within a **Protobuf wrapper (`GeoRoutedMsg`)**. This acts as a metadata envelope, attaching critical attributes:
-* **Payload**: The raw J2735 UPER binary.
-* **Location**: High-precision GPS coordinates (Lat/Long).
-* **Timestamp**: Creation time for latency tracking.
+
+- **Payload**: The raw J2735 UPER binary.
+- **Location**: High-precision GPS coordinates (Lat/Long).
+- **Timestamp**: Creation time for latency tracking.
 
 **Note: See below for how to generate these bindings yourself.**
 
 ### 3. MQTT Transport
+
 The serialized Protobuf object is sent as the MQTT payload to a topic structured by the client's current Geohash (e.g., `vzimp/1/GeoRelevance/...`).
 
 ### 4. Spatial Delivery
+
 The ETX broker parses the Geohash from the topic and the coordinates from the Protobuf header. It then "shuttles" the message to all relevant subscribers within a neighboring grid, ensuring the data reaches exactly who needs it based on physical proximity.
 
-## 📡 Messaging Patterns
+## Messaging Patterns
+
 ETX supports four distinct communication patterns to meet diverse ITS requirements:
 
-* **Public Broadcast**: Ecosystem-wide safety alerts (BSM/PSM).
-* **Private Broadcast**: Proprietary fleet-wide updates.
-* **Public Targeted**: Direct, point-to-point interactions (Session ID based).
-* **Private Targeted**: Secure, authorized exchanges between specific peers.
+- **Status Messages**: Ecosystem-wide status messages (BSM/PSM). Distributed to applications monitoring the area where the clients are.
+- **Broadcast Alert Messages**: Ecosystem-wide safety alerts (TIM/RSA). Anyone in the area is notified.
+- **Targeted Alert Messages**: Direct, point-to-point interactions messages. Delivering alerts/notifications to a particular client.
 
 **Note:** The reliability of these messages are subject to the delivery semantics of the MQTT standards. Please view our API for more information.
 
-## ❓ Documents
+## Documents
 
 - A debugging guide for ETX registration is [provided here](./docs/DEBUGGING.md).
 
-## 🛠️ Generate Protobuf Bindings
+## Generate Protobuf Bindings
 
 Protobuf bindings are needed if you want to interact with ETX directly without the help of the language bindings provided in this project.
 
-**NOTE: Protobuf encoding/decoding is already happening in the langauge bindings provided!** 
+**NOTE: Protobuf encoding/decoding is already happening in the language bindings provided!**
 
 ### Python
 
@@ -66,31 +73,16 @@ Protobuf bindings are needed if you want to interact with ETX directly without t
 mkdir -p ./proto/dist/python
 
 # 2. Install grpc tools.
-pip install grpcio-tools
+pip3 install grpcio-tools
 
 # 3. Generate protobuf output. 
-python -m grpc_tools.protoc \
+python3 -m grpc_tools.protoc \
     -I=./proto \
     --python_out=./proto/dist/python \
     --pyi_out=./proto/dist/python \
     ./proto/georoutedmsg.proto
 ```
 
-Our bindings use the following version grpcio-tools:
-
-```text
-Name: grpcio-tools
-Version: 1.76.0
-Summary: Protobuf code generator for gRPC
-Home-page: https://grpc.io
-Author: The gRPC Authors
-Author-email: grpc-io@googlegroups.com
-License: Apache License 2.0
-Location: /Users/hsuyu/.virtualenvs/test2/lib/python3.11/site-packages
-Requires: grpcio, protobuf, setuptools
-Required-by: 
-```
-
 ### Node
 
 ```bash
@@ -111,13 +103,3 @@ npx protoc \
   -I=./proto \
   ./proto/georoutedmsg.proto
 ```
-
-Our bindings use the follow version:
-
-```text
-etx-starter-kit@0.2.0 /Users/hsuyu/Documents/projects/v2x/oss/etx-starter-kit
-└── ts-proto@2.11.0
-
-etx-starter-kit@0.2.0 /Users/hsuyu/Documents/projects/v2x/oss/etx-starter-kit
-└── protobufjs@8.0.0
-```

etx/README.md

@@ -10,16 +10,14 @@ This version of the client sample has been tested against **v22.16.0**. It utili
 
 ### Prerequisite - Setup
 
-The fastest way to get started is to download the packages from release. The latest release can be [found here](https://github.com/5GRealityLab/etx-starter-kit/releases/latest). 
+The fastest way to get started is to download the packages from release. The latest release can be [found here](https://github.com/Verizon/EdgeTransportationExchange_SampleClient/releases/latest).
 
 The file to download will look like: `node-etx-sample-x.x.x.zip`, where x.x.x is the version fo the project.
 
-1. **Install Dependencies**: 
-
-   **Install With Pip**
+1. **Install Dependencies**:
 
    ```bash
-   curl -L -O https://github.com/5GRealityLab/etx-starter-kit/releases/latest/download/node-etx-sample-x.x.x.zip
+   curl -L -O https://github.com/Verizon/EdgeTransportationExchange_SampleClient/releases/latest/download/node-etx-sample-x.x.x.zip
    unzip node-etx-sample-x.x.x.zip -d node-etx-sample
    cd node-etx-sample
    npm install ./j2735codec/j2735codec-*.tgz 
@@ -38,15 +36,16 @@ The file to download will look like: `node-etx-sample-x.x.x.zip`, where x.x.x is
    | **identity** | `user` | String | Your Verizon ThingSpace account username. |
    | | `password` | String | Your Verizon ThingSpace account password. |
    | | `token` | String | The Base64 encoded Application Token (Client ID:Client Secret) from ThingSpace. |
-   | **attributes**| `clientType` | String | The broad category of the client (e.g., `Vehicle`, `VulnerableRoadUser`, etc). |
+   | **attributes** | `clientType` | String | The broad category of the client (e.g., `Vehicle`, `VulnerableRoadUser`, etc). |
    | | `clientSubType` | String | The specific type of vehicle (e.g., `PassengerCar`, `Truck`, `Radar`, etc). |
    | | `vendorId` | String | An identifier for the software or hardware provider. |
    | **location** | `lat` | Float | The initial latitude for the device (used during registration/geofencing). |
    | | `lon` | Float | The initial longitude for the device. |
 
-**Note: The latitude and longitude determines which edge server you will conenct to.**
+**Note: The latitude and longitude determines which edge server you will connect to.**
 
 **Note: The `Endpoints` section in the config is optional and does not have to be filled out or included in the final `config.json`.**
+
 ```json
 "endpoints": {
    "oauthUrl": "https://thingspace.verizon.com/api/ts/v1/oauth2/token",
@@ -71,22 +70,23 @@ The following command line arguments are supported by all examples in the next s
 
 ### 0. Registration Example
 
-The registration example is a precursor to performing any other operations on ETX. This step retrieves a unique **Device ID** and the **mTLS certificates** (CA, Certificate, and Private Key) required to connect. 
+The registration example is a precursor to performing any other operations on ETX. This step retrieves a unique **Device ID** and the **mTLS certificates** (CA, Certificate, and Private Key) required to connect.
 
 **IMPORTANT**: Each vendor ID has a fixed quota of device IDs. Always keep track of your registrations and deregister when finished.
 
 #### How to Run
+
 ```bash
-npm run registration -- --config config.json --cert-dir ./certs
+npm run registration -- --config config.json --cert-dir ./registrations
 ```
 
-**Output**: The above command generates a JSON "Identity Artifact" in the `./certs/` folder. This file contains everything needed to "re-hydrate" your identity in the following examples.
+**Output**: The above command generates a JSON "Identity Artifact" in the `./registrations/` folder. This file contains everything needed to "re-hydrate" your identity in the following examples.
 
 #### Supported Arguments
 
 | Arg | Required | Default | Description |
 | :--- | :--- | :--- | :--- |
-| --cert-dir| False | ./cert/ | The local directory where security certificates and keys are generated after registration completes.  |
+| --cert-dir | False | ./cert/ | The local directory where security certificates and keys are generated after registration completes. |
 | --config | False | config.json | The configuration file to use for registration. |
 
 ---
@@ -97,9 +97,10 @@ The deregistration example removes the registered device from ETX. Every vendor
 
 #### How to Run
 
-The command format to run this example (from the project root): 
+The command format to run this example (from the project root):
+
 ```bash
-npm run deregistration -- --device-files ./certs/20260119_0101_f355703d.json 
+npm run deregistration -- --device-file ./registrations/20260119_0101_f355703d.json 
 ```
 
 #### Supported Arguments
@@ -110,7 +111,7 @@ npm run deregistration -- --device-files ./certs/20260119_0101_f355703d.json
 
 ---
 
-### 2. Private Loopback Example 
+### 2. Private Loopback Example
 
 A diagnostic tool to verify bidirectional private communication.
 
@@ -119,9 +120,11 @@ A diagnostic tool to verify bidirectional private communication.
 3. Publishes a BSM to itself to verify the mTLS loop is closed.
 
 #### How to Run
+
 ```bash
-npm run loopback -- --device-file ./certs/20260119_0101_f355703d.json  --count 5
+npm run loopback -- --device-file ./registrations/20260119_0101_f355703d.json  --count 5
 ```
+
 #### Supported Arguments
 
 | Arg | Required | Default | Description |
@@ -134,13 +137,17 @@ npm run loopback -- --device-file ./certs/20260119_0101_f355703d.json  --count 5
 ### 3. Speed Monitor Example (RSU/App)
 
 Demonstrates a "Virtual Speed Trap" application.
+
 1. **Geohashing**: Subscribes to regional topics by delimiting geohashes (e.g., `d/r/5/r/9/y`).
 2. **Real-time Analytics**: Decodes BSMs from all vehicles in the neighborhood.
 3. **Targeted Advisory**: If a vehicle exceeds the `--limit`, it sends a **TIM (Traveler Information Message)** warning directly to that specific vehicle's private topic.
 
+**Hint**: Run the Vehicle Example with a separate registration to trigger the speeding alert. **Remember to use two different registration profiles! One for the monitor and one for the vehicle.**
+
 #### How to Run
+
 ```bash
-npm run speedmon -- --device-file ./certs/20260119_0101_f355703d.json  --limit 25
+npm run speedmon -- --device-file ./registrations/20260119_0101_f355703d.json  --limit 25
 ```
 
 #### Supported Arguments
@@ -149,47 +156,52 @@ npm run speedmon -- --device-file ./certs/20260119_0101_f355703d.json  --limit 2
 | :--- | :--- | :--- | :--- |
 | --device-file | True | - | The device file to use for ETX connection. |
 | --lat | False | - | The default value is defined in the registration config file. |
-| --lon | False | - | The default value is defined in the registraiton config file. |
+| --lon | False | - | The default value is defined in the registration config file. |
 | --limit | False | 25 | The speed limit in mph to send out warnings. |
 
 ---
 
 ### 4. Vehicle Example (OBU)
 
 Simulates a mobile entity (On-Board Unit). It demonstrates the "Public Broadcast" pattern used in real-world V2X.
+
 1. **Session Handshake**: Connects and retrieves a Session ID from `vzimp/1/ClientInfo`.
 2. **Periodic Broadcast**: Runs a background thread to publish BSMs to the `GeoRelevance` topic at 1Hz.
 3. **Regional Listening**: Subscribes to regional safety messages (TIM, SPaT, MAP).
 
+**Hint**: Run this example with the Speed Monitor Example running at the same time to trigger the speeding alert. Make sure the speed value is above the speed limit configured in the monitoring application. **Remember to use two different registration profiles! One for the monitor and one for the vehicle.**
+
 #### How to Run
+
 ```bash
-npm run vehicle -- --device-file ./certs/20260119_0101_f355703d.json  --speed 25
+npm run vehicle -- --device-file ./registrations/20260119_0101_f355703d.json  --speed 25
 ```
 
-**Note**: You can try running both the speed monitor and vehicle example together to see when TIM messages are sent to warn the vehicle of speed limit violations. **Remember to use two different registration profiles! One for the monitor and one for the vehicle.**
-
 #### Supported Arguments
 
 | Arg | Required | Default | Description |
 | :--- | :--- | :--- | :--- |
 | --device-file | True | - | The device file to use for ETX connection. |
 | --lat | False | - | The default value is defined in the registration config file. |
-| --lon | False | - | The default value is defined in the registraiton config file. |
+| --lon | False | - | The default value is defined in the registration config file. |
 | --speed | False | 30 | The speed in which the vehicle is traveling at. |
+
 ---
 
 ### Install and Running From Source (For Project Contributors)
 
-It is possible to run the examples directly from this project as well. Check the prequisites for the building the [language bindings here](/README.md#2-source-install).
+It is possible to run the examples directly from this project as well.
+
+**Note: Make sure that you satisfy the prerequisites for building the [language bindings](/j2735codec/README.md#source-installation) before building the node js examples.**
 
 ```bash
-git clone https://github.com/5GRealityLab/etx-starter-kit.git
-cd etx-starter-kit
+git clone https://github.com/Verizon/EdgeTransportationExchange_SampleClient.git
+cd EdgeTransportationExchange_SampleClient/j2735codec
 make install-js
 cd etx/examples/node
+npm run registration -- --config config.json --cert-dir ./registrations
 
-# Run examples above 
-
+# Run examples above.
 ```
 
 ---