Skip to content

Latest commit

 

History

History
638 lines (580 loc) · 22.3 KB

spec_IT.md

File metadata and controls

638 lines (580 loc) · 22.3 KB

Smart Data Models

Entità: BatteryStatus

Licenza aperta

documento generato automaticamente

Descrizione globale: Rappresenta uno stato per una batteria fisica.

versione: 0.0.3

Elenco delle proprietà

[*] Se non c'è un tipo in un attributo è perché potrebbe avere diversi tipi o diversi formati/modelli.

  • acPowerInput[number]: Valore numerico in volt per la carica a corrente alternata . Model: http://schema.org/Number
  • acPowerOutput[number]: Valore numerico in volt per l'uscita alternata . Model: http://schema.org/Number
  • address[object]: L'indirizzo postale . Model: https://schema.org/address
  • alternateName[string]: Un nome alternativo per questa voce
  • areaServed[string]: L'area geografica in cui viene fornito il servizio o l'articolo offerto. . Model: https://schema.org/Text
  • dataProvider[string]: una sequenza di caratteri che identifica il fornitore dell'entità di dati armonizzata
  • dateCreated[date-time]: Timestamp di creazione dell'entità. Di solito viene assegnato dalla piattaforma di archiviazione
  • dateModified[date-time]: Timestamp dell'ultima modifica dell'entità. Di solito viene assegnato dalla piattaforma di archiviazione
  • dcPowerInput[number]: Valore numerico in volt per la carica in corrente continua . Model: http://schema.org/Number
  • dcPowerOutput[number]: Valore numerico in volt per la carica in corrente continua . Model: http://schema.org/Number
  • description[string]: Descrizione dell'articolo
  • id[*]: Identificatore univoco dell'entità
  • location[*]: Riferimento geojson all'elemento. Può essere un punto, una stringa di linea, un poligono, un multi-punto, una stringa di linea o un poligono multiplo.
  • name[string]: Il nome di questo elemento
  • owner[array]: Un elenco contenente una sequenza di caratteri codificata JSON che fa riferimento agli ID univoci dei proprietari.
  • refBattery[*]: Riferimento all'entità batteria . Model: http://schema.org/URL
  • seeAlso[*]: elenco di uri che puntano a risorse aggiuntive sull'elemento
  • source[string]: Una sequenza di caratteri che indica la fonte originale dei dati dell'entità come URL. Si consiglia di utilizzare il nome di dominio completamente qualificato del provider di origine o l'URL dell'oggetto di origine.
  • statusPercent[number]: Percentuale di carica disponibile per la batteria . Model: http://schema.org/Number
  • type[string]: Tipo di entità NGSI. Deve essere BatteryStatus

Proprietà richieste

  • id
  • refBattery
  • statusPercent
  • type

Modello di dati descrizione delle proprietà

Ordinati in ordine alfabetico (clicca per i dettagli)

full yaml details 
BatteryStatus:    
  description: Represent a status for a physical battery.    
  properties:    
    acPowerInput:    
      description: Numeric value in volts for the alternate current charge    
      type: number    
      x-ngsi:    
        model: http://schema.org/Number    
        type: Property    
        units: volts    
    acPowerOutput:    
      description: Numeric value in volts for the alternate output    
      type: number    
      x-ngsi:    
        model: http://schema.org/Number    
        type: Property    
        units: volts    
    address:    
      description: The mailing address    
      properties:    
        addressCountry:    
          description: 'The country. For example, Spain'    
          type: string    
          x-ngsi:    
            model: https://schema.org/addressCountry    
            type: Property    
        addressLocality:    
          description: 'The locality in which the street address is, and which is in the region'    
          type: string    
          x-ngsi:    
            model: https://schema.org/addressLocality    
            type: Property    
        addressRegion:    
          description: 'The region in which the locality is, and which is in the country'    
          type: string    
          x-ngsi:    
            model: https://schema.org/addressRegion    
            type: Property    
        district:    
          description: 'A district is a type of administrative division that, in some countries, is managed by the local government'    
          type: string    
          x-ngsi:    
            type: Property    
        postOfficeBoxNumber:    
          description: 'The post office box number for PO box addresses. For example, 03578'    
          type: string    
          x-ngsi:    
            model: https://schema.org/postOfficeBoxNumber    
            type: Property    
        postalCode:    
          description: 'The postal code. For example, 24004'    
          type: string    
          x-ngsi:    
            model: https://schema.org/https://schema.org/postalCode    
            type: Property    
        streetAddress:    
          description: The street address    
          type: string    
          x-ngsi:    
            model: https://schema.org/streetAddress    
            type: Property    
        streetNr:    
          description: Number identifying a specific property on a public street    
          type: string    
          x-ngsi:    
            type: Property    
      type: object    
      x-ngsi:    
        model: https://schema.org/address    
        type: Property    
    alternateName:    
      description: An alternative name for this item    
      type: string    
      x-ngsi:    
        type: Property    
    areaServed:    
      description: The geographic area where a service or offered item is provided    
      type: string    
      x-ngsi:    
        model: https://schema.org/Text    
        type: Property    
    dataProvider:    
      description: A sequence of characters identifying the provider of the harmonised data entity    
      type: string    
      x-ngsi:    
        type: Property    
    dateCreated:    
      description: Entity creation timestamp. This will usually be allocated by the storage platform    
      format: date-time    
      type: string    
      x-ngsi:    
        type: Property    
    dateModified:    
      description: Timestamp of the last modification of the entity. This will usually be allocated by the storage platform    
      format: date-time    
      type: string    
      x-ngsi:    
        type: Property    
    dateObserved:    
      description: Date of the observed entity defined by the user    
      format: date-time    
      type: string    
      x-ngsi:    
        type: Property    
    dcPowerInput:    
      description: Numeric value in volts for the continuous current charge    
      type: number    
      x-ngsi:    
        model: http://schema.org/Number    
        type: Property    
        units: volts    
    dcPowerOutput:    
      description: Numeric value in volts for the continuous current charge    
      type: number    
      x-ngsi:    
        model: http://schema.org/Number    
        type: Property    
        units: volts    
    description:    
      description: A description of this item    
      type: string    
      x-ngsi:    
        type: Property    
    id:    
      anyOf:    
        - description: Identifier format of any NGSI entity    
          maxLength: 256    
          minLength: 1    
          pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$    
          type: string    
          x-ngsi:    
            type: Property    
        - description: Identifier format of any NGSI entity    
          format: uri    
          type: string    
          x-ngsi:    
            type: Property    
      description: Unique identifier of the entity    
      x-ngsi:    
        type: Property    
    location:    
      description: 'Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon'    
      oneOf:    
        - description: Geojson reference to the item. Point    
          properties:    
            bbox:    
              items:    
                type: number    
              minItems: 4    
              type: array    
            coordinates:    
              items:    
                type: number    
              minItems: 2    
              type: array    
            type:    
              enum:    
                - Point    
              type: string    
          required:    
            - type    
            - coordinates    
          title: GeoJSON Point    
          type: object    
          x-ngsi:    
            type: GeoProperty    
        - description: Geojson reference to the item. LineString    
          properties:    
            bbox:    
              items:    
                type: number    
              minItems: 4    
              type: array    
            coordinates:    
              items:    
                items:    
                  type: number    
                minItems: 2    
                type: array    
              minItems: 2    
              type: array    
            type:    
              enum:    
                - LineString    
              type: string    
          required:    
            - type    
            - coordinates    
          title: GeoJSON LineString    
          type: object    
          x-ngsi:    
            type: GeoProperty    
        - description: Geojson reference to the item. Polygon    
          properties:    
            bbox:    
              items:    
                type: number    
              minItems: 4    
              type: array    
            coordinates:    
              items:    
                items:    
                  items:    
                    type: number    
                  minItems: 2    
                  type: array    
                minItems: 4    
                type: array    
              type: array    
            type:    
              enum:    
                - Polygon    
              type: string    
          required:    
            - type    
            - coordinates    
          title: GeoJSON Polygon    
          type: object    
          x-ngsi:    
            type: GeoProperty    
        - description: Geojson reference to the item. MultiPoint    
          properties:    
            bbox:    
              items:    
                type: number    
              minItems: 4    
              type: array    
            coordinates:    
              items:    
                items:    
                  type: number    
                minItems: 2    
                type: array    
              type: array    
            type:    
              enum:    
                - MultiPoint    
              type: string    
          required:    
            - type    
            - coordinates    
          title: GeoJSON MultiPoint    
          type: object    
          x-ngsi:    
            type: GeoProperty    
        - description: Geojson reference to the item. MultiLineString    
          properties:    
            bbox:    
              items:    
                type: number    
              minItems: 4    
              type: array    
            coordinates:    
              items:    
                items:    
                  items:    
                    type: number    
                  minItems: 2    
                  type: array    
                minItems: 2    
                type: array    
              type: array    
            type:    
              enum:    
                - MultiLineString    
              type: string    
          required:    
            - type    
            - coordinates    
          title: GeoJSON MultiLineString    
          type: object    
          x-ngsi:    
            type: GeoProperty    
        - description: Geojson reference to the item. MultiLineString    
          properties:    
            bbox:    
              items:    
                type: number    
              minItems: 4    
              type: array    
            coordinates:    
              items:    
                items:    
                  items:    
                    items:    
                      type: number    
                    minItems: 2    
                    type: array    
                  minItems: 4    
                  type: array    
                type: array    
              type: array    
            type:    
              enum:    
                - MultiPolygon    
              type: string    
          required:    
            - type    
            - coordinates    
          title: GeoJSON MultiPolygon    
          type: object    
          x-ngsi:    
            type: GeoProperty    
      x-ngsi:    
        type: GeoProperty    
    name:    
      description: The name of this item    
      type: string    
      x-ngsi:    
        type: Property    
    owner:    
      description: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)    
      items:    
        anyOf:    
          - description: Identifier format of any NGSI entity    
            maxLength: 256    
            minLength: 1    
            pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$    
            type: string    
            x-ngsi:    
              type: Property    
          - description: Identifier format of any NGSI entity    
            format: uri    
            type: string    
            x-ngsi:    
              type: Property    
        description: Unique identifier of the entity    
        x-ngsi:    
          type: Property    
      type: array    
      x-ngsi:    
        type: Property    
    refBattery:    
      anyOf:    
        - description: Identifier format of any NGSI entity    
          maxLength: 256    
          minLength: 1    
          pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$    
          type: string    
          x-ngsi:    
            type: Property    
        - description: Identifier format of any NGSI entity    
          format: uri    
          type: string    
          x-ngsi:    
            type: Property    
      description: Reference to the battery entity    
      x-ngsi:    
        model: http://schema.org/URL    
        type: Relationship    
    seeAlso:    
      description: list of uri pointing to additional resources about the item    
      oneOf:    
        - items:    
            format: uri    
            type: string    
          minItems: 1    
          type: array    
        - format: uri    
          type: string    
      x-ngsi:    
        type: Property    
    source:    
      description: 'A sequence of characters giving the original source of the entity data as a URL. Recommended to be the fully qualified domain name of the source provider, or the URL to the source object'    
      type: string    
      x-ngsi:    
        type: Property    
    statusPercent:    
      description: Percentage of charge available for the battery    
      maximum: 1    
      minimum: 0    
      type: number    
      x-ngsi:    
        model: http://schema.org/Number    
        type: Property    
    type:    
      description: NGSI Entity type. It has to be BatteryStatus    
      enum:    
        - BatteryStatus    
      type: string    
      x-ngsi:    
        type: Property    
  required:    
    - id    
    - type    
    - refBattery    
    - statusPercent    
  type: object    
  x-derived-from: ""    
  x-disclaimer: 'Redistribution and use in source and binary forms, with or without modification, are permitted  provided that the license conditions are met. Copyleft (c) 2023 Contributors to Smart Data Models Program'    
  x-license-url: https://github.com/smart-data-models/dataModel.Battery/blob/master/BatteryStatus/LICENSE.md    
  x-model-schema: https://smart-data-models.github.io/dataModel.Battery/BatteryStatus/schema.json    
  x-model-tags: ""    
  x-version: 0.0.4

Esempi di payload

Valori chiave BatteryStatus NGSI-v2 Esempio

Ecco un esempio di BatteryStatus in formato JSON-LD come valori-chiave. Questo è compatibile con NGSI-v2 quando si usa options=keyValues e restituisce i dati di contesto di una singola entità.

show/hide example 
{  
  "id": "BatteryStatus:santander:energy:d95372df39",  
  "type": "BatteryStatus",  
  "dataProvider": "bike-in.com",  
  "dateObserved": "2019-09-23T15:59:09.224Z",  
  "refBattery": "Battery:santander:energy:bac-d95372df39",  
  "statusPercent": 0.97,  
  "acPowerInput": 0,  
  "acPowerOutput": 0.01  
}

BatteryStatus NGSI-v2 normalizzato Esempio

Ecco un esempio di BatteryStatus in formato JSON-LD normalizzato. Questo è compatibile con NGSI-v2 quando non si usano opzioni e restituisce i dati di contesto di una singola entità.

show/hide example 
{  
  "id": "BatteryStatus:santander:energy:d95372df39",  
  "type": "BatteryStatus",  
  "dataProvider": {  
    "type": "Text",  
    "value": "bike-in.com"  
  },  
  "dateObserved": {  
    "type": "DateTime",  
    "value": "2019-09-23T15:59:09.224Z"  
  },  
  "refBattery": {  
    "type": "Text",  
    "value": "Battery:santander:energy:d95372df39"  
  },  
  "statusPercent": {  
    "type": "Number",  
    "value": 0.9  
  },  
  "acPowerInput": {  
    "type": "Number",  
    "value": 0.01  
  },  
  "acPowerOutput": {  
    "type": "Number",  
    "value": 0.02  
  }  
}

Valori chiave BatteryStatus NGSI-LD Esempio

Ecco un esempio di BatteryStatus in formato JSON-LD come valori-chiave. Questo è compatibile con NGSI-LD quando si usa options=keyValues e restituisce i dati di contesto di una singola entità.

show/hide example 
{  
  "id": "urn:ngsi-ld:BatteryStatus:santander:energy:d95372df39",  
  "type": "BatteryStatus",  
  "acPowerInput": 0,  
  "acPowerOutput": 0.01,  
  "dataProvider": "bike-in.com",  
  "dateObserved": "2019-09-23T15:59:09.224Z",  
  "refBattery": "urn:ngsi-ld:Battery:santander:d95372df39",  
  "source": "bike-in.com",  
  "statusPercent": 0.98,  
  "@context": [  
    "https://raw.githubusercontent.com/smart-data-models/dataModel.Battery/master/context.jsonld"  
  ]  
}

BatteryStatus NGSI-LD normalizzato Esempio

Ecco un esempio di BatteryStatus in formato JSON-LD normalizzato. Questo è compatibile con NGSI-LD quando non si usano opzioni e restituisce i dati di contesto di una singola entità.

show/hide example 
{  
    "id": "urn:ngsi-ld:BatteryStatus:santander:energy:bs-ac-d95372df39",  
    "type": "BatteryStatus",  
    "acPowerInput": {  
        "type": "Property",  
        "value": 0.01  
    },  
    "acPowerOutput": {  
        "type": "Property",  
        "value": 0.0  
    },  
    "dataProvider": {  
        "type": "Property",  
        "value": "bike-in.com"  
    },  
    "dateObserved": {  
        "type": "Property",  
        "value": {  
            "@type": "DateTime",  
            "@value": "2019-09-23T15:59:09.224Z"  
        }  
    },  
    "refBattery": {  
        "type": "Relationship",  
        "object": "urn:ngsi-ld:Battery:santander:energy:ac-d95372df39"  
    },  
    "statusPercent": {  
        "type": "Property",  
        "value": 0.9  
    },  
    "@context": [  
        "https://raw.githubusercontent.com/smart-data-models/dataModel.Battery/master/context.jsonld"  
    ]  
}

Vedere FAQ 10 per ottenere una risposta su come gestire le unità di grandezza.

Smart Data Models +++ Contribution Manual +++ About