SmartSpot

This repository is now archived and subsequent works will be carried out the in Smart data models repositories.

Description

Smart Spots are devices which provide the technology which allows users to get access to smart points of interaction so that they can obtain extra information (infotainment, etc.), provide suggestions (suggestions mailbox, etc.) or generate new content (co-creation, etc.). The data model contains resources to configure the interaction service such as the broadcasted URL (typically shortened), the period between broadcasts, the availability of the service, transmission power depending on the area to be covered, etc.

In addition to the presented data model, this entity type inherits from the Device entity type. This means that by hierarchy, the SmartSpot entity type is a subtype of Device and as a result it can be the subject of any of the properties that an entity of type Device may have.

Data Model

The data model is defined as shown below:

• id : Unique identifier.

• type : Entity type. It must be equal to SmartSpot.

• source : A sequence of characters giving the source of the entity data.

  • Attribute type: Property. Text or URL
  • Optional

• dataProvider : Specifies the URL to information about the provider of this information

  • Attribute type: Property. URL
  • Optional

• announcedUrl : URL broadcasted by the device.

  • Attribute type: Property. URL
  • Mandatory

• signalStrength : Signal strength to adjust the announcement range.

  • Attribute type: Property. Text
  • Allowed values: "lowest", "medium" or "highest".
  • Mandatory

• bluetoothChannel : Bluetooth channels where to transmit the announcement.

  • Attribute type: Property. Text
  • Allowed values: "37", "38", "39", "37,38", "38,39", "37,39" or "37,38,39".
  • Mandatory

• coverageRadius : Radius of the spot coverage area in meters.

  • Attribute type: Property. Number
  • Default unit: Meters.
  • Optional

• announcementPeriod : Period between announcements.

  • Attribute type: Property. Number
  • Default unit: Milliseconds.
  • Mandatory

• availability: Specifies the functionality intervals in which the announcements will be sent. The syntax must be conformant with schema.org openingHours specification. For instance, a service which is only active on dayweeks will be encoded as "availability": "Mo,Tu,We,Th,Fr,Sa 09:00-20:00".

  • Attribute type: Property. Text
  • Mandatory.

• refSmartPointOfInteraction : Reference to the Smart Point of Interaction which includes this Smart Spot.

  • Attribute type: Relationship. Reference to an entity of type SmartPointOfInteraction
  • Optional

Note: JSON Schemas are intended to capture the data type and associated constraints of the different Attributes, regardless their final representation format in NGSI(v2, LD).

Examples

Normalized Example

Normalized NGSI response

{
    "id": "SSPOT-F94C51A295D9",
    "type": "SmartSpot",
    "announcementPeriod": {
        "value": 500
    },
    "signalStrength": {
        "value": "highest"
    },
    "announcedUrl": {
        "value": "http://goo.gl/EJ81JP"
    },
    "availability": {
        "value": "Tu,Th 16:00-20:00"
    },
    "coverageRadius": {
        "value": 30
    },
    "bluetoothChannel": {
        "value": "37,38,39"
    },
    "refSmartPointOfInteraction": {
        "type": "Relationship",
        "value": "SPOI-ES-4326"
    }
}

key-value pairs Example

Sample uses simplified representation for data consumers ?options=keyValues

{
    "id": "SSPOT-F94C51A295D9",
    "type": "SmartSpot",
    "announcedUrl": "http://goo.gl/EJ81JP",
    "signalStrength": "high",
    "bluetoothChannel": "37-38-39",
    "coverageRadius": 30,
    "announcementPeriod": 500,
    "availability": "Tu,Th 16:00-20:00",
    "refSmartPointOfInteraction": "SPOI-ES-4326"
}

LD Example

Sample uses the NGSI-LD representation

{
    "id": "urn:ngsi-ld:SmartSpot:SSPOT-F94C51A295D9",
    "type": "SmartSpot",
    "announcementPeriod": {
        "type": "Property",
        "value": 500
    },
    "signalStrength": {
        "type": "Property",
        "value": "highest"
    },
    "announcedUrl": {
        "type": "Property",
        "value": "http://goo.gl/EJ81JP"
    },
    "availability": {
        "type": "Property",
        "value": "Tu,Th 16:00-20:00"
    },
    "coverageRadius": {
        "type": "Property",
        "value": 30
    },
    "bluetoothChannel": {
        "type": "Property",
        "value": "37,38,39"
    },
    "refSmartPointOfInteraction": {
        "type": "Relationship",
        "object": "urn:ngsi-ld:SmartPointOfInteraction:SPOI-ES-4326"
    },
    "@context": [
        "https://schema.lab.fiware.org/ld/context",
        "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld"
    ]
}

Use it with a real service

T.B.D.