Scooterrific: IoT mobility data demo contract

Used in Internet of Things Hardware
for mobility

This demo contract shows how to classify some.

We link on producer ID (e.g. different brands of mobility scooters). The rider ID and GPS are classified as sensitive.

We validate both the GPS (coordinates) and rider ID (UUID) with PCRE regexes.

Event Contract reference

strm-demo/scooterrific-contract/1.0.0

Schema reference

strm-demo/scooterrific/1.0.0

Event contract overview

Type	Field	Value	Description
Key field	producer_id		Links events to the associated field for privacy processing.
PII field	GPS	1	needs consent
PII field	rider_id	1	needs consent
Validation	GPS	regex	^([-+]?)([\d]{1,2})(((\.)(\d+)(,)))(\s*)(([-+]?)([\d]{1,3})((\.)(\d+))?)$
Validation	rider_id	regex	\b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b

Serialization schema fields

Field	Description
device_id	the id of the scooter
rider_id	.
GPS	the GPS coordinates
charge	the charge left in the battery
current_speed	.
brake_pressure	.
producer_id	the id of the producer/customer, e.g. ScooterCom

Event contract

{
  "id": "a918dc46-79d3-492e-ba88-709f5a392c97",
  "is_public": true,
  "key_field": "producer_id",
  "metadata": {
      "create_time": "2022-03-11T14:10:04Z",
      "description": "This demo contract shows how to classify some.\n\nWe link on producer ID (e.g. different brands of mobility scooters). The rider ID and GPS are classified as sensitive. \n\nWe validate both the GPS (coordinates) and rider ID (UUID) with PCRE regexes. ",
      "domains": [
          "Internet of Things",
          "Hardware"
      ],
      "icon_uri": "https://cdn-icons-png.flaticon.com/512/502/502766.png",
      "industries": [
          "mobility"
      ],
      "title": "Scooterrific: IoT mobility data demo contract"
  },
  "pii_fields": {
      "GPS": 1,
      "rider_id": 1
  },
  "ref": {
      "handle": "strm-demo",
      "name": "scooterrific-contract",
      "version": "1.0.0"
  },
  "schema_ref": {
      "handle": "strm-demo",
      "name": "scooterrific",
      "version": "1.0.0"
  },
  "state": "DRAFT",
  "validations": [
      {
          "field": "GPS",
          "type": "regex",
          "value": "^([-+]?)([\\d]{1,2})(((\\.)(\\d+)(,)))(\\s*)(([-+]?)([\\d]{1,3})((\\.)(\\d+))?)$"
      },
      {
          "field": "rider_id",
          "type": "regex",
          "value": "\\b[0-9a-f]{8}\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\b[0-9a-f]{12}\\b"
      }
  ]
}

Serialization schema

{
  "type": "record",
  "name": "scooterrific",
  "namespace": "StrmDemo.scooterrific.v1_0_0",
  "fields": [
      {
          "name": "strmMeta",
          "type": {
              "type": "record",
              "name": "strmMeta",
              "namespace": "StrmDemo.scooterrific.v1_0_0.strmmeta",
              "fields": [
                  {
                      "name": "eventContractRef",
                      "type": "string"
                  },
                  {
                      "name": "nonce",
                      "type": [
                          "null",
                          "int"
                      ],
                      "default": null
                  },
                  {
                      "name": "timestamp",
                      "type": [
                          "null",
                          "long"
                      ],
                      "default": null
                  },
                  {
                      "name": "keyLink",
                      "type": [
                          "null",
                          "string"
                      ],
                      "default": null
                  },
                  {
                      "name": "billingId",
                      "type": [
                          "null",
                          "string"
                      ],
                      "default": null
                  },
                  {
                      "name": "consentLevels",
                      "type": {
                          "type": "array",
                          "items": "int"
                      }
                  }
              ]
          }
      },
      {
          "name": "device_id",
          "type": [
              "null",
              "string"
          ],
          "doc": "the id of the scooter",
          "default": null
      },
      {
          "name": "rider_id",
          "type": [
              "null",
              "string"
          ],
          "default": null
      },
      {
          "name": "GPS",
          "type": [
              "null",
              "string"
          ],
          "doc": "the GPS coordinates",
          "default": null
      },
      {
          "name": "charge",
          "type": [
              "null",
              "string"
          ],
          "doc": "the charge left in the battery",
          "default": null
      },
      {
          "name": "current_speed",
          "type": [
              "null",
              "float"
          ],
          "default": null
      },
      {
          "name": "brake_pressure",
          "type": [
              "null",
              "float"
          ],
          "doc": "the pressure applied to the brake in % of max",
          "default": null
      },
      {
          "name": "producer_id",
          "type": [
              "null",
              "string"
          ],
          "doc": "the id of the producer/customer, e.g. ScooterCom",
          "default": null
      }
  ]
}