Description of the fields to import

Content:

  • Importing devices
  • Gateways import.
  • Importing Suppliers
  • Import of consumers
  • Import of metering points.
  • Importing objects

Importing devices

name is the name of the device. Required field. An arbitrary set of characters from 2 to 255 is specified.

metering_device_model_id is the device model. Required field. A numeric value that is automatically inserted into the template.

interface_id — Connection interface. Required field. A numeric value that is automatically inserted into the template.

deviceTimezone — The time zone of the device. Required field. A number from -12 to 12 is specified.

report_period_update — The polling period of the device. Required field. The number of seconds is specified.

serial_number — Serial number. Optional field. An arbitrary set of characters from 1 to 255 is specified.

type_water_meter — Resource type. Required field for water meters. Possible values:

  • hot is DHW
  • cold is CWS

direction_water_meter is the direction of the resource. Required field for water meters. Possible values:

  • direct
  • reverse

authorization_type Required field when the LoRaWAN interface is selected. Possible values:

  • ABP Additional fields:
    • DevAddr is DevAddr is a required field when the ABP authorization type is selected. It can contain letters of the Latin alphabet from a to f and numbers from 0 to 9. The length is 8 characters.
    • AppSKey is AppSKey is a required field when the ABP authorization type is selected. It can contain letters of the Latin alphabet from a to f and numbers from 0 to 9. The length is 32 characters.
    • NwkSKey is NwkSKey is a required field when the ABP authorization type is selected. It can contain letters of the Latin alphabet from a to f and numbers from 0 to 9. The length is 32 characters.
  • OTAA Additional fields:
    • DevEUI is DevEUI is a required field for the selected OTAA authorization type. It can contain letters of the Latin alphabet from a to f and numbers from 0 to 9. The length is 16 characters.
    • AppKey is AppKey is a required field for the selected OTAA authorization type. It can contain letters of the Latin alphabet from a to f and numbers from 0 to 9. The length is 32 characters.

use3g — 3G usage when connecting the base station to the internet. Required field when the LoRaWAN interface is selected. Possible values:

  • 0 — No
  • 1 — Yes

freq_plan is frequency plan. Required field when the LoRaWAN interface is selected. Possible values:

  • vega— RU868
  • nekta— Nekta
  • smartiko— Smartiko
  • europe— EU868
  • UA868— UA868

base_station is priority base station. Optional field. Available only when the LoRaWAN interface is selected. It can contain letters of the Latin alphabet from a to f and numbers from 0 to 9. The length is 16 characters.

DeviceID is the device ID. Required field when selecting certain models or interfaces. Consists of Prefix and ID. The ID can contain letters of the Latin alphabet from a to f and numbers from 0 to 9, most often the IMEI of the device acts as the ID. The maximum length is 16 characters. Possible values of Prefix:

  • net868_
  • actility_
  • waviot_
  • lartech_

modem_mode is mode of operation of the modem. Required field when GSM/GPRS or Ethernet interface is selected. Possible values:

  • client
    • IMEI Required field for the selected modem operation mode Client. An arbitrary set of characters from 1 to 255 is specified.
    • inside_addr is network address. Required field for the selected modem operation mode Client. A numeric value from 0 to 999999999 is specified.
  • server
    • ip — IP address/Url. Required field for the selected server modem operation mode. The IP address is specified as four decimal numbers with a value from 0 to 255, separated by dots.
    • port is the port. Required field for the selected modem operation mode the server. A numeric value from 0 to 65535 is specified.
    • inside_addr is network address. Required field for the selected modem operation mode is server. A numeric value from 0 to 999999999 is specified.

software_7e1 is emulation of 7E1. Required field when GSM/GPRS or Ethernet interface is selected. Possible values:

  • false
  • true

transformation_ratio is transformation coefficient. Mandatory field for electricity meters. A numeric value from 0 to 9999 is specified.

Gateways import.

name is the name of the device*. Example of the value:Device 1

gateway_model_id is gateway model*. Example value: 222 (Vega SI-12)

interface_id is connection interface*. Example value: 1 (LoRaWAN)

deviceTimezone is time zone of the device*. Example value: 4

report_period_update — Update period*.

Possible values:

  • 60 — 1 minute
  • 300 — 5 minutes
  • 900 — 15 minutes
  • 1800 — 30 minutes
  • 3600 — 1 hour
  • 21600 — 6 hours
  • 43200 — 12 hours
  • 86400 — 24 hours
  • 172800 — 48 hours
  • 259200 — 72 hours
  • 604800 — 1 week
  • 1209600 — 2 weeks
  • 2592000 — 1 month

authorization_type — Activation Type*.

Possible values:

  • ABP

Additional fields

  • DevAddr— DevAddr *
  • AppSKey— AppSKey *
  • NwkSKey— NwkSKey *
  • OTAA

Additional fields

  • DevEUI— DevEUI *
  • AppKey— AppKey *

use3g — 3G* is used.

Possible values:

  • 0 — No
  • 1 — Yes

freq_plan is frequency plan*.

Possible values:

  • vega— RU868
  • nekta— Nekta
  • smartiko— Smartiko
  • europe— EU868
  • UA868— UA868
  • KZ868

base_station is Priority BS

Importing Suppliers

name is the name of the supplier. Required field. An arbitrary set of characters is specified in the amount from 5 to 250.

inn is TIN of the supplier. Required field. 10 or 12 digits are indicated.

number_of_contract is contract number/personal account. Required field. An arbitrary set of characters from 1 to 250 is specified.

Import of consumers

name is the name of the consumer. Required field. An arbitrary set of characters is specified in the amount from 5 to 250.

subject_type_id  Possible values:

  • 1 — An individual
  • 2 — Legal entity

inn is the TIN of the consumer. Required field. 10 or 12 digits are indicated.

number_of_contract is contract number/personal account. Required field. An arbitrary set of characters from 1 to 250 is specified.

Import of metering points.

name is metering point name. Required field. An arbitrary set of characters from 1 to 255 is specified.

resource_type_id is resource type. Required field. Possible values:

  • 1 — DHW
  • 2 — CWS
  • 3 — Power supply
  • 4 — Heat supply
  • 5 — Gas supply

point_number is MP number. Required field. A numeric value with the number of characters from 1 to 255 is specified. The value must be unique within the same account.

device_id specifies a numeric value that must correspond to the ID of the device created in the system, you can find out from the ID column in the devices section.

consumer_inn is the TIN of the consumer. Optional field. A numeric value is specified, which must correspond to the TIN of the consumer created in the system.

supplier_inn is the TIN of the supplier. Optional field. A numeric value is specified, which must correspond to the TIN of the supplier created in the system.

admission_to_operation_at is date of commissioning. Required field. Specified in the format DD.MM.YYYY.

comment is comment. Optional field. An arbitrary set of characters from 1 to 255 is specified.

object_name is the name of the object. Optional field. Specifies the value that should correspond to the name of the object or sub-object created in the system.

direction is the direction of the meter. 1 is forward, 2 is reverse.

object_id is the ID of the object to which the metering point is binded. In order to find out the object ID, you need to download the xls file by clicking on the button in the upper right corner, export objects and copy the value specified in the _id column.

Importing objects

name is the name of the infrastructure element*. Example value:MKD No. 1

country is Country (used only for objects). Example of the value:Russia

region is Region (used only for objects). Example of the value:Samara region

city is City (used only for objects). Example of the value:Togliatti

street is Street (used only for objects). Example value: 70 years of October

house (used only for objects). Example value: 47

coordinates (used only for objects) (format: latitude,longitude). Example values: 53.5383663,49.2649187

type of the infrastructure element. Example of the value:An object

Possible values:

  • folder is Folder
  • object is Object
  • innerObject is a Subobject

A subobject can only be within an object.

type is the type of the object. Example value: 2

Possible values (for the object):

  • 1 — Shopping/Business center
  • 2 — Multi-storey building
  • 3 — Private house
  • 4 — pre-school facility
  • 5 — high school
  • 6 — university
  • 7 — Production facility
  • 8 — Transformer substation

Possible values (for a subobject):

  • 100 — Apartment
  • 101 — Office
  • 102 — Shop
  • 103 — Warehouse

 

   Send article as PDF