Configure a measuring point.

Parameters:

measuring_point_id:

The ID of the measuring point which you'd like to configure. If omitted it will create a new measuring point.

Expects the body of the request to be a JSON dictionary. Note that all values passed are expected to be in the user profiles unit of distance. Also note that it will be removed from a project if coupled to one when using the API.

The following can be set using the API

Body options:

name:

Name for the measuring point

sensor_name:

six letter name which is located on the front sticker, can be blank for no Swarm connected

postal_code (optional):

Postal code

house_number (optional):

House number

street_name (optional):

Street name

city (optional):

City

disable_led:

true or false, setting it to true will turn of the led on the front of the Swarm when there is an active connection to the server.

log_flush_interval:

Interval in seconds, when there are measurements which didn't cause an alarm they will be send at this interval.

timezone:

The timezone in which the Swarm is. One of: Pacific/Palau, Africa/Ndjamena, America/Yellowknife, America/Fort_Wayne, Indian/Reunion, Asia/Harbin, Pacific/Tahiti, America/Tegucigalpa, Asia/Novokuznetsk, US/Mountain, America/Danmarkshavn, Etc/GMT-0, Europe/Rome, Brazil/East, ROK, Atlantic/Bermuda, America/North_Dakota/Beulah, Etc/GMT-7, Asia/Krasnoyarsk, Asia/Novosibirsk, Asia/Atyrau, America/Belize, Europe/Jersey, Pacific/Kiritimati, Europe/Minsk, America/Nipigon, Asia/Tashkent, America/Lower_Princes, Etc/GMT+0, Pacific/Truk, Asia/Barnaul, Pacific/Nauru, Africa/Bamako, Europe/Monaco, Eire, Brazil/DeNoronha, Egypt, America/Phoenix, Pacific/Enderbury, Atlantic/Jan_Mayen, Asia/Kuching, Asia/Phnom_Penh, America/Cambridge_Bay, America/Edmonton, America/Detroit, Mexico/BajaSur, Asia/Aden, Asia/Karachi, America/Argentina/ComodRivadavia, America/Antigua, Asia/Vladivostok, Africa/Kinshasa, Asia/Beirut, Etc/GMT+4, America/Costa_Rica, Portugal, America/Cuiaba, Africa/Bujumbura, Asia/Bangkok, Europe/Sofia, America/Buenos_Aires, Europe/Chisinau, Africa/Khartoum, Pacific/Chatham, Europe/Sarajevo, Indian/Mauritius, America/Havana, Australia/Brisbane, America/Atikokan, Europe/Brussels, MST7MDT, Europe/Busingen, America/Guyana, Etc/GMT+2, America/Chicago, America/Vancouver, Europe/Bratislava, Europe/Ljubljana, Europe/Vienna, America/Mendoza, America/Grenada, America/Manaus, NZ, Indian/Maldives, America/Los_Angeles, Africa/Kigali, Etc/UTC, America/Nuuk, Universal, Asia/Istanbul, Asia/Manila, Africa/Harare, Africa/Ouagadougou, Pacific/Pohnpei, Australia/Queensland, Asia/Chungking, Canada/Pacific, Asia/Macau, Indian/Antananarivo, Asia/Kabul, Europe/Berlin, Asia/Yerevan, Europe/Belgrade, Canada/Central, Asia/Kamchatka, Asia/Srednekolymsk, Africa/Asmera, Pacific/Samoa, Asia/Ujung_Pandang, Poland, Asia/Saigon, Pacific/Funafuti, Antarctica/Palmer, US/East-Indiana, Asia/Baghdad, Africa/Kampala, Etc/GMT-10, America/Catamarca, Cuba, Africa/Lome, Asia/Urumqi, Australia/LHI, Australia/Perth, Pacific/Chuuk, Antarctica/Vostok, Hongkong, America/Porto_Acre, Asia/Hovd, America/El_Salvador, Africa/Algiers, Asia/Oral, Europe/Astrakhan, Africa/Maseru, America/Argentina/Mendoza, Pacific/Guam, Europe/Vilnius, Asia/Tokyo, Africa/Maputo, America/Santarem, Europe/Isle_of_Man, America/North_Dakota/Center, Asia/Damascus, Africa/El_Aaiun, Asia/Famagusta, CET, Australia/Lindeman, Asia/Tbilisi, America/Maceio, America/Port_of_Spain, Asia/Omsk, America/Louisville, America/St_Johns, GMT, Australia/Melbourne, Antarctica/Syowa, Brazil/West, Europe/Gibraltar, Indian/Cocos, America/Rankin_Inlet, America/Cayenne, America/St_Lucia, Pacific/Honolulu, Asia/Dili, Australia/Tasmania, Etc/Universal, Europe/Vatican, America/Argentina/Ushuaia, Pacific/Wallis, Canada/Eastern, Africa/Timbuktu, Etc/GMT-8, Australia/Lord_Howe, America/Toronto, Pacific/Rarotonga, Asia/Tehran, Canada/Yukon, Asia/Pontianak, America/Argentina/Jujuy, America/Menominee, WET, Australia/Darwin, America/Indiana/Indianapolis, Pacific/Yap, America/Goose_Bay, America/Indiana/Vincennes, America/Santo_Domingo, Atlantic/South_Georgia, Africa/Nairobi, Africa/Sao_Tome, Europe/Tallinn, Etc/GMT-1, Australia/Canberra, Asia/Tel_Aviv, America/Managua, America/Blanc-Sablon, Atlantic/Stanley, Asia/Ust-Nera, America/Virgin, Arctic/Longyearbyen, America/Juneau, America/Argentina/La_Rioja, Zulu, America/Argentina/Tucuman, America/Argentina/San_Juan, Asia/Nicosia, America/Monterrey, Atlantic/Faroe, GB-Eire, Pacific/Tongatapu, Asia/Gaza, America/Fortaleza, Africa/Accra, Africa/Abidjan, America/Indianapolis, America/Guayaquil, Africa/Dakar, Africa/Mogadishu, Antarctica/McMurdo, EST, Etc/GMT+12, America/Panama, America/Grand_Turk, Pacific/Pago_Pago, CST6CDT, Pacific/Auckland, America/Iqaluit, America/Santiago, America/Halifax, Asia/Shanghai, America/Scoresbysund, Singapore, America/Campo_Grande, Africa/Douala, America/Argentina/Rio_Gallegos, Europe/Simferopol, Canada/Atlantic, Asia/Anadyr, Europe/Andorra, America/Tijuana, Australia/ACT, Asia/Kashgar, Pacific/Norfolk, America/Inuvik, Pacific/Guadalcanal, Etc/GMT-14, America/Bahia_Banderas, America/Martinique, Pacific/Tarawa, Pacific/Port_Moresby, America/Yakutat, Africa/Niamey, America/Bogota, Pacific/Majuro, Africa/Libreville, Europe/Kaliningrad, US/Central, Pacific/Apia, Africa/Bissau, America/Nome, Etc/GMT0, Etc/GMT+9, America/Moncton, Africa/Djibouti, Atlantic/St_Helena, Chile/Continental, Iceland, America/Paramaribo, Atlantic/Reykjavik, Asia/Dacca, Indian/Mayotte, US/Eastern, Africa/Monrovia, GMT0, Asia/Kuwait, Etc/GMT-4, Africa/Banjul, America/Coral_Harbour, America/Asuncion, Europe/Guernsey, America/Knox_IN, Africa/Casablanca, Europe/Helsinki, Europe/Paris, Atlantic/Azores, America/Cayman, Asia/Riyadh, Europe/Amsterdam, Asia/Macao, GMT+0, America/Swift_Current, Asia/Almaty, Pacific/Noumea, Asia/Hebron, Australia/South, Australia/Victoria, Europe/Dublin, America/Denver, America/Rio_Branco, Pacific/Efate, America/Lima, Asia/Thimbu, Asia/Aqtobe, ROC, America/Guadeloupe, Chile/EasterIsland, Europe/Lisbon, America/Glace_Bay, America/Metlakatla, Europe/Istanbul, Israel, PRC, America/Indiana/Winamac, Antarctica/Davis, Africa/Cairo, America/Caracas, NZ-CHAT, Etc/GMT-3, America/Porto_Velho, Europe/Kirov, Asia/Brunei, America/Chihuahua, Australia/Yancowinna, Navajo, Asia/Aqtau, Europe/Prague, America/Argentina/Buenos_Aires, Asia/Dubai, Asia/Ulaanbaatar, Australia/Currie, America/Recife, GB, Africa/Dar_es_Salaam, America/Boise, America/Anguilla, Etc/GMT+8, America/Boa_Vista, Etc/GMT-2, Europe/Skopje, America/Nassau, Atlantic/Cape_Verde, Mexico/General, Etc/GMT+10, Greenwich, UTC, America/Adak, Europe/Bucharest, Asia/Katmandu, Asia/Magadan, America/Rainy_River, Indian/Chagos, Pacific/Ponape, Indian/Mahe, Africa/Luanda, America/Barbados, America/Sao_Paulo, Asia/Calcutta, Antarctica/Rothera, America/Indiana/Vevay, Etc/GMT-6, Etc/UCT, America/Belem, America/Dominica, America/Creston, America/Eirunepe, America/Montreal, Asia/Jakarta, Europe/Warsaw, Europe/Zaporozhye, Japan, Brazil/Acre, Pacific/Fakaofo, Etc/GMT+11, Europe/Saratov, Pacific/Galapagos, America/Resolute, America/Indiana/Marengo, Asia/Pyongyang, Europe/Vaduz, America/Bahia, Kwajalein, Asia/Ashgabat, US/Samoa, Europe/Zagreb, Europe/Tirane, Antarctica/Mawson, Antarctica/South_Pole, America/Mexico_City, Europe/London, Europe/Tiraspol, Australia/North, Pacific/Saipan, Jamaica, America/Argentina/San_Luis, America/Guatemala, America/Thunder_Bay, Asia/Ashkhabad, America/Regina, Europe/Uzhgorod, Canada/Mountain, Libya, Turkey, EST5EDT, Etc/GMT-5, Mexico/BajaNorte, America/Thule, Etc/Greenwich, Antarctica/Macquarie, America/Winnipeg, Europe/Oslo, Pacific/Wake, Asia/Hong_Kong, Etc/GMT, America/Santa_Isabel, Etc/Zulu, Pacific/Marquesas, Europe/Madrid, Asia/Dhaka, Pacific/Kwajalein, Pacific/Gambier, Asia/Samarkand, Pacific/Kanton, America/Montserrat, America/Curacao, US/Indiana-Starke, Asia/Chita, Africa/Tunis, America/Cordoba, Asia/Taipei, Antarctica/Casey, Asia/Amman, Africa/Blantyre, Iran, Asia/Baku, PST8PDT, Africa/Juba, Africa/Lubumbashi, Africa/Porto-Novo, America/Noronha, Etc/GMT+5, America/St_Thomas, America/Punta_Arenas, America/Sitka, America/Dawson, Europe/Belfast, Asia/Qyzylorda, W-SU, Africa/Malabo, Africa/Mbabane, America/Argentina/Catamarca, Europe/Moscow, Africa/Nouakchott, Asia/Bishkek, America/La_Paz, Europe/Mariehamn, Europe/Samara, America/Whitehorse, Asia/Bahrain, Etc/GMT-9, America/Indiana/Knox, MET, Europe/Budapest, America/Argentina/Cordoba, Africa/Ceuta, Asia/Seoul, US/Pacific, America/Araguaina, America/Indiana/Petersburg, America/Port-au-Prince, Canada/Newfoundland, Asia/Jayapura, Antarctica/DumontDUrville, Africa/Windhoek, America/Matamoros, Australia/Broken_Hill, America/Shiprock, Asia/Chongqing, America/Cancun, Asia/Yangon, Asia/Kuala_Lumpur, Africa/Asmara, Pacific/Midway, Asia/Jerusalem, America/Kentucky/Louisville, Australia/Sydney, Etc/GMT-13, Australia/Eucla, Pacific/Niue, Europe/Zurich, US/Hawaii, Canada/Saskatchewan, Europe/Riga, Etc/GMT+3, MST, America/Hermosillo, Asia/Irkutsk, Europe/San_Marino, Australia/NSW, Etc/GMT-12, America/New_York, Europe/Copenhagen, Asia/Kolkata, Pacific/Pitcairn, Asia/Colombo, Atlantic/Canary, Europe/Malta, Asia/Yakutsk, America/Ojinaga, America/Montevideo, Atlantic/Faeroe, Indian/Christmas, Asia/Choibalsan, Asia/Makassar, America/Mazatlan, Africa/Addis_Ababa, GMT-0, Antarctica/Troll, Europe/Ulyanovsk, Asia/Thimphu, Europe/Luxembourg, Indian/Kerguelen, US/Arizona, Europe/Volgograd, America/Godthab, America/Miquelon, Europe/Kiev, Pacific/Fiji, Asia/Rangoon, Africa/Tripoli, Europe/Nicosia, Asia/Yekaterinburg, Africa/Johannesburg, America/Kentucky/Monticello, Asia/Muscat, Africa/Lusaka, America/Dawson_Creek, America/Jujuy, America/Merida, UCT, US/Michigan, Africa/Freetown, Europe/Stockholm, Australia/Adelaide, America/Tortola, Africa/Bangui, Asia/Kathmandu, America/St_Kitts, Etc/GMT+1, America/Atka, America/Anchorage, Asia/Ho_Chi_Minh, Africa/Lagos, America/Marigot, Asia/Singapore, Asia/Sakhalin, Pacific/Kosrae, Pacific/Johnston, America/North_Dakota/New_Salem, US/Aleutian, America/St_Vincent, Africa/Conakry, America/Argentina/Salta, America/Indiana/Tell_City, US/Alaska, Asia/Vientiane, Asia/Ulan_Bator, Pacific/Bougainville, America/Aruba, Europe/Athens, Indian/Comoro, Etc/GMT+7, Asia/Dushanbe, America/St_Barthelemy, America/Kralendijk, HST, Africa/Gaborone, Asia/Khandyga, Etc/GMT-11, Pacific/Easter, America/Rosario, America/Puerto_Rico, America/Pangnirtung, Etc/GMT+6, Asia/Tomsk, America/Fort_Nelson, Australia/West, America/Jamaica, EET, America/Ensenada, Africa/Brazzaville, Atlantic/Madeira, Europe/Podgorica, Australia/Hobart, Asia/Qatar, Asia/Qostanay

guide_line:

One of: SBR_A_2017, Circulaire86, BS7385_250Hz, ISEE_250Hz, SBR_B_2002, UNE_22_381_93, SS_4604861, SS_025211, IN1226, SBR_A_2010, SN640312a, DIN4150_2, ONORM_S_9020, DIN4150_3_80Hz

category (optional):

One of: CAT3, CAT2, CAT1

building_level:

One of: buildingClass3, pipeline, lowerLevel, floorSlabs, unspecified, OSMRE_1983, buildingClass4, dinFoundation, structure, USBM_RI8507_drywall, freshConcrete, guidelineValues, buildingClass2, buildingClass5, selfDefined, highestFloor, buildingClass1, undergroundCavities, USBM_RI8507_plaster, foundation

flat_level:

Only available when the building_level is set to unspecified. This will be an absolute value as alarm level.

vector_enabled:

Off, On, setting it to On will store the PVS (peak vector sum) and also trigger (non frequency dependend) alarms based on PVS.

vdv_enabled:

Off, On, setting it to On will calculate and store VDV (vibration dose value)

atop_enabled:

Off, On, setting it to On will calculate and store PPA (peak particle acceleration)

vtop_enabled:

Off, On, setting it to Off will prevent calculating and storing PPV (peak particle acceleration)

vdv_period:

Will be used as the measurement duration for calculating VDV

vdv_x:

One of: ISO2631_Wj, BS6841_Wg, ISO2631_Wk, ISO8041_Wh, ISO2631_Wm, BS6841_Wd, ISO2631_Wf, ISO2631_Wd, BS6841_Wc, BS6841_We, BS6841_Wf, ISO2631_We, BS6841_Wb, ISO2631_Wc, ISO5349_Wh

vdv_y:

One of: ISO2631_Wj, BS6841_Wg, ISO2631_Wk, ISO8041_Wh, ISO2631_Wm, BS6841_Wd, ISO2631_Wf, ISO2631_Wd, BS6841_Wc, BS6841_We, BS6841_Wf, ISO2631_We, BS6841_Wb, ISO2631_Wc, ISO5349_Wh

vdv_z:

One of: ISO2631_Wj, BS6841_Wg, ISO2631_Wk, ISO8041_Wh, ISO2631_Wm, BS6841_Wd, ISO2631_Wf, ISO2631_Wd, BS6841_Wc, BS6841_We, BS6841_Wf, ISO2631_We, BS6841_Wb, ISO2631_Wc, ISO5349_Wh

measuring_type:

Needed with SBR, DIN 4150-3 and Circulaire86 measurements. One of indicative, extensive, limited

concrete_setting_level

Used with IN 1226. One of lessThan10MPa, rc10MPaTo15MPa, lessThan2hours, moreThan15MPa

vibration_source

Used with IN 1226. One of compaction, mechanicalDevices, pilingSheetingExcavation, blasting

vibration_type:

Needed with SBR, DIN 4150-3 and Circulaire86 measurements. One of peak, longTerm, continually, impulsive, momentarily, continuous, repeated, shortTerm

building_state:

Needed with SBR 2017. One of normal, sensitive

zet_gev_laagdikte:

Needed with SBR 2017 when the category is foundation. One of H_7m, H_3m, H_1m, H_5m, H_2m, H_6m, H_4m, H_8m

lining_material:

One of: materialClass3, reinforcedConcreteAndTubing, masonry, concreteAndStone, materialClass4, materialClass2, materialClass1

construction_type:

One of: structureType3, resistantConstruction, structureType2, verySensitiveConstruction, designClass1, sensitiveConstruction, designClass3, platformAndCatenaryPost, structureType1, designClass2

pipeline_type:

One of: weldedSteel, brickworkAndPlastic, concreteAndSteel

data_save_level:

float number in mm/s, threshold for storing measurement samples

measurement_duration:

Interval in seconds, at this interval samples will be taken

trace_save_level:

float number in mm/s, threshold for storing traces

trace_pre_trigger:

float number in seconds: when trace_save_level was passed how many seconds before are included in the trace

trace_post_trigger:

float number in seconds: when trace_save_level was passed how many seconds after are included in the trace

alarm_level_1:

int number in percentage: percentage of the guideline which will cause an alarm for group 1

alarm_level_2:

int number in percentage: percentage of the guideline which will cause an alarm for group 2

alarm_level_3:

int number in percentage: percentage of the guideline which will cause an alarm for group 3

email_delay:

int number in seconds: how much time will there be between two e-mails

alarm_recipients:

a list of lists containing 3 strings: where the first element is the type, the second element the value for the type and the last element which alarm level should trigger sending the notification.

webhook_recipient (optional):

an extra recipient that sends alarm notifications to a webhook. The webhook will send POST requests with a UTF-8-encoded JSON body containing the notification info. The secret provided combined with the request body will be hashed using HMAC sha-256. The hash will be placed inside of the http-header: X-Omnidots-Notifier-Signature. Make sure to calculate the hash on the receiving end as well and to compare these hashes.

There will be some variation between the different types and categories of notifications but all of them will atleast contain the following information:

{
    "measuring_point_id": 1337,
    "category": "sensor_went_online",
    "level": "success",
    "created_at": 1618488056.925577,
    "data": { "sensor": "HOSEVE", "datetime": 1618488056.922907 },
    "text": "Your Swarm HOSEVE went online on April 15, 2021, 2:00:56 p.m. CEST."
}

enable_time_[0-6]:

Scheduled start time of the Swarm, note that 0 is Sunday

disable_time_[0-6]:

Scheduled end time of the Swarm, note that 0 is Sunday

Example body:

{
    "name": "Test 123",
    "sensor_name": "BANANA"
    "postal_code": "1234 AB",
    "house_number": 56,
    "street_name": "Test road",
    "city": "Awesome town",
    "disable_led": true,
    "log_flush_interval": 60,
    "timezone": "Europe/Amsterdam",
    "guide_line": "SBR_A",
    "category": "CAT1",
    "measuring_type": "Extensive",
    "vibration_type": "Repeated",
    "data_save_level": 0.2,
    "measurement_duration": 2.0,
    "trace_save_level": 10.0,
    "trace_pre_trigger": 3.0,
    "trace_post_trigger": 3.0,
    "alarm_level_1": 90,
    "alarm_level_2": 100,
    "alarm_level_3": 100,
    "email_delay": 120,
    "alarm_recipients": [
        ["phone_number", "+31850070336", "alarm_level_3"],
        ["phone_number", "+31850070336", "measuring_point_administrator"],
        ["email", "info@omnidots.com", "alarm_level_1"]
    ],
    "webhook_recipient": {
        "url": "https://your-web-address.domain/webhook",
        "secret": "high-entropy-secret-0l25a9df7d8afd5ec",
        "alarm_level_1": false,
        "alarm_level_2": false,
        "alarm_level_3": false,
        "measuring_point_administrator": true
    },
    "enable_time_0": "00:00:00",
    "disable_time_0": "23:59:59",
    "enable_time_1": "00:08:00",
    "disable_time_1": "18:00:00",
    "enable_time_2": "00:00:00",
    "disable_time_2": "23:59:59",
    "enable_time_3": "00:00:00",
    "disable_time_3": "23:59:59",
    "enable_time_4": "00:00:00",
    "disable_time_4": "23:59:59",
    "enable_time_5": "00:00:00",
    "disable_time_5": "23:59:59",
    "enable_time_6": "00:00:00",
    "disable_time_6": "23:59:59",
}

Available API endpoints: