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: Europe/Bucharest, America/Denver, America/Nome, Asia/Chongqing, Africa/Brazzaville, America/Costa_Rica, Asia/Hovd, Etc/GMT+5, Asia/Tomsk, Asia/Jerusalem, America/Argentina/Rio_Gallegos, America/Indiana/Marengo, America/Halifax, Turkey, Pacific/Tarawa, Asia/Kolkata, America/Louisville, Europe/Malta, America/Argentina/San_Juan, Pacific/Efate, Asia/Chungking, UCT, Indian/Maldives, MST7MDT, Pacific/Marquesas, Pacific/Gambier, Africa/Kinshasa, Atlantic/Faeroe, NZ, America/Guyana, Etc/GMT-5, US/Indiana-Starke, America/Argentina/Salta, Pacific/Chuuk, GMT, America/Cuiaba, America/Catamarca, Asia/Tokyo, Greenwich, America/Kralendijk, EST, Asia/Almaty, Etc/GMT-12, MST, Pacific/Midway, Africa/Monrovia, Asia/Kamchatka, Etc/GMT+1, America/Eirunepe, Asia/Seoul, America/St_Johns, Pacific/Tongatapu, Etc/GMT-9, America/Recife, Europe/Brussels, America/Argentina/La_Rioja, Australia/NSW, Europe/London, America/Inuvik, America/Ojinaga, Pacific/Palau, Asia/Barnaul, Africa/Ouagadougou, America/Belem, America/Argentina/Buenos_Aires, Indian/Mayotte, Asia/Nicosia, US/Michigan, Africa/Addis_Ababa, Asia/Manila, Africa/Gaborone, Asia/Hebron, Canada/Pacific, Europe/Isle_of_Man, PST8PDT, Indian/Reunion, Europe/Kaliningrad, America/Argentina/Ushuaia, Cuba, America/Asuncion, America/Grand_Turk, Europe/Guernsey, Asia/Katmandu, Africa/Lome, Pacific/Nauru, Asia/Kuching, Europe/Prague, America/Maceio, US/Aleutian, Etc/GMT0, America/Managua, Asia/Qatar, Europe/Berlin, Asia/Yangon, Europe/Saratov, Europe/Astrakhan, Asia/Rangoon, America/Caracas, Asia/Chita, Atlantic/Canary, Pacific/Yap, Europe/Paris, Africa/Sao_Tome, America/Mendoza, Indian/Antananarivo, Asia/Dhaka, Pacific/Ponape, America/Porto_Acre, America/Jujuy, America/Belize, US/Pacific, America/Port-au-Prince, Australia/Perth, Asia/Pyongyang, Africa/Maseru, Africa/Kigali, Asia/Omsk, Europe/Riga, Europe/Chisinau, Australia/Currie, WET, Asia/Baku, Kwajalein, Etc/GMT-7, America/Fort_Wayne, America/Nipigon, Canada/Yukon, America/St_Lucia, Africa/Freetown, Asia/Famagusta, Asia/Qostanay, America/Nuuk, Asia/Shanghai, Asia/Qyzylorda, America/Regina, Asia/Jayapura, America/Lower_Princes, Asia/Dacca, Africa/Douala, Indian/Mauritius, Etc/Greenwich, America/Rainy_River, Africa/Luanda, Etc/GMT+10, Pacific/Truk, Europe/Amsterdam, America/Thunder_Bay, Pacific/Galapagos, America/Moncton, America/Marigot, America/Bogota, US/Mountain, Arctic/Longyearbyen, Pacific/Apia, Pacific/Wallis, Africa/Casablanca, Asia/Atyrau, Africa/Asmara, Etc/GMT-0, Asia/Yerevan, US/Eastern, GB, Asia/Vientiane, America/Grenada, Australia/ACT, Etc/GMT+8, America/Panama, Etc/Universal, PRC, America/Atka, America/Goose_Bay, Europe/Skopje, Pacific/Pago_Pago, Universal, Africa/Lagos, America/Montreal, Antarctica/Davis, Europe/Oslo, Asia/Tel_Aviv, Pacific/Majuro, Pacific/Easter, Africa/Blantyre, America/Rankin_Inlet, Australia/Hobart, America/Knox_IN, Europe/Istanbul, Israel, MET, Asia/Phnom_Penh, Pacific/Funafuti, America/Cayenne, Indian/Kerguelen, America/Cambridge_Bay, America/Argentina/ComodRivadavia, America/Mexico_City, Indian/Chagos, Australia/West, Pacific/Pitcairn, Australia/LHI, Africa/Mbabane, Etc/GMT-4, America/Argentina/Tucuman, Australia/Lord_Howe, Pacific/Kanton, Asia/Dushanbe, Africa/Tunis, Mexico/BajaSur, Pacific/Fakaofo, Atlantic/Madeira, Asia/Thimphu, Iceland, Africa/Malabo, America/Cayman, Zulu, America/Mazatlan, Africa/Khartoum, EST5EDT, America/Coral_Harbour, Etc/GMT+6, Etc/Zulu, Pacific/Saipan, Asia/Harbin, America/La_Paz, Africa/Tripoli, America/Indiana/Vincennes, Portugal, Asia/Anadyr, Asia/Ho_Chi_Minh, Pacific/Auckland, Etc/GMT-13, Europe/Lisbon, America/St_Vincent, Europe/Zurich, Asia/Samarkand, Europe/Gibraltar, Asia/Vladivostok, Europe/Vienna, Europe/Monaco, Atlantic/Reykjavik, America/Argentina/Jujuy, Asia/Kuwait, Australia/Tasmania, Pacific/Port_Moresby, Australia/Darwin, Europe/Rome, Pacific/Samoa, America/Argentina/Catamarca, Antarctica/Macquarie, Asia/Kuala_Lumpur, America/Metlakatla, America/Montserrat, America/Curacao, Europe/Tirane, Etc/UTC, Africa/Bangui, Asia/Gaza, Africa/Johannesburg, Asia/Tashkent, Pacific/Chatham, Pacific/Kwajalein, Brazil/West, ROK, America/Toronto, Asia/Yekaterinburg, America/Dawson, Asia/Pontianak, America/Bahia, Africa/Conakry, Eire, America/Phoenix, Asia/Calcutta, Asia/Baghdad, Asia/Dili, Asia/Ulaanbaatar, America/Chicago, Africa/Windhoek, Asia/Muscat, Europe/Sarajevo, Australia/Sydney, Africa/Djibouti, Atlantic/Stanley, Australia/Queensland, Asia/Thimbu, America/Menominee, America/Detroit, America/Blanc-Sablon, Etc/GMT-11, Africa/Cairo, Canada/Saskatchewan, Asia/Macao, Africa/Asmera, Africa/Bamako, Asia/Aqtau, Europe/Uzhgorod, America/North_Dakota/Center, Antarctica/Rothera, Asia/Istanbul, Europe/Moscow, Pacific/Niue, Australia/Melbourne, Australia/Adelaide, America/Havana, America/St_Barthelemy, Antarctica/DumontDUrville, Antarctica/South_Pole, Etc/GMT-1, America/Barbados, Australia/Brisbane, Canada/Mountain, Etc/GMT+2, America/Cordoba, Asia/Kashgar, Africa/Niamey, America/Edmonton, America/Yellowknife, Antarctica/Troll, Europe/Vilnius, Navajo, America/Jamaica, America/Merida, Europe/Nicosia, Pacific/Rarotonga, Africa/Maputo, America/Santiago, America/Atikokan, Asia/Sakhalin, America/Indiana/Winamac, Africa/Mogadishu, Atlantic/Bermuda, Antarctica/McMurdo, CST6CDT, Asia/Bangkok, Europe/Belfast, Mexico/General, Asia/Ujung_Pandang, GB-Eire, Canada/Atlantic, America/Sao_Paulo, Atlantic/Azores, America/Scoresbysund, Pacific/Johnston, America/Kentucky/Louisville, Atlantic/St_Helena, Pacific/Enderbury, America/Anchorage, America/Campo_Grande, Atlantic/Jan_Mayen, Asia/Srednekolymsk, America/Rosario, Europe/Madrid, Africa/Timbuktu, Asia/Riyadh, Brazil/East, NZ-CHAT, US/Central, US/Alaska, Etc/GMT-10, Europe/Belgrade, Pacific/Bougainville, Pacific/Kiritimati, Europe/Simferopol, America/Port_of_Spain, Europe/Kirov, America/Yakutat, Asia/Tehran, America/Lima, Europe/Jersey, America/Thule, America/Swift_Current, America/Rio_Branco, Egypt, GMT+0, Indian/Comoro, US/Samoa, America/Guadeloupe, America/St_Thomas, America/El_Salvador, America/Santa_Isabel, Australia/Victoria, America/Santarem, Etc/GMT+0, America/Bahia_Banderas, Africa/El_Aaiun, Europe/Mariehamn, Europe/Volgograd, America/Tijuana, America/Boise, America/Puerto_Rico, America/Manaus, Asia/Saigon, America/Punta_Arenas, America/North_Dakota/Beulah, Pacific/Norfolk, Pacific/Honolulu, Etc/GMT, America/Miquelon, Antarctica/Vostok, Asia/Taipei, Etc/GMT+4, Etc/GMT-6, Africa/Kampala, Etc/GMT+9, Antarctica/Syowa, America/Tortola, EET, America/Nassau, Europe/Budapest, Asia/Damascus, America/Shiprock, Europe/Ulyanovsk, America/Porto_Velho, GMT0, America/Winnipeg, Europe/Stockholm, Asia/Bahrain, America/Danmarkshavn, Asia/Kathmandu, America/Araguaina, Asia/Jakarta, America/Buenos_Aires, Australia/North, Jamaica, Asia/Krasnoyarsk, America/Antigua, Pacific/Guam, America/Indiana/Indianapolis, America/North_Dakota/New_Salem, Africa/Dakar, Europe/Minsk, America/Anguilla, America/Matamoros, Asia/Khandyga, America/Indianapolis, America/Resolute, US/Hawaii, America/Guatemala, Africa/Nouakchott, Asia/Aqtobe, Etc/GMT+12, Africa/Abidjan, America/Monterrey, Asia/Kabul, Brazil/Acre, Australia/Canberra, Atlantic/Faroe, Europe/Andorra, Chile/EasterIsland, Asia/Ulan_Bator, Poland, US/Arizona, Brazil/DeNoronha, America/Fort_Nelson, Asia/Hong_Kong, America/Argentina/Cordoba, Asia/Ashkhabad, America/Creston, Etc/GMT+7, America/Juneau, Europe/Vaduz, Africa/Porto-Novo, Pacific/Wake, America/Adak, Asia/Dubai, Australia/Broken_Hill, Asia/Novosibirsk, Asia/Ust-Nera, Africa/Bujumbura, Africa/Nairobi, America/Aruba, Asia/Macau, Africa/Ceuta, America/Paramaribo, Pacific/Fiji, Europe/Dublin, Asia/Beirut, America/Tegucigalpa, Antarctica/Mawson, Europe/Helsinki, America/Guayaquil, Atlantic/Cape_Verde, Canada/Eastern, Europe/Sofia, Europe/Zaporozhye, Africa/Accra, Africa/Juba, Canada/Newfoundland, UTC, America/St_Kitts, Asia/Choibalsan, GMT-0, Asia/Bishkek, Europe/Samara, America/Indiana/Tell_City, Iran, America/Montevideo, Etc/UCT, America/Godthab, Africa/Algiers, Asia/Brunei, America/Indiana/Vevay, America/Martinique, Asia/Magadan, Pacific/Tahiti, Antarctica/Palmer, Asia/Amman, Asia/Colombo, America/Fortaleza, Africa/Banjul, America/Argentina/Mendoza, Etc/GMT-2, Europe/Bratislava, Europe/Warsaw, Europe/Zagreb, Singapore, America/Los_Angeles, America/Santo_Domingo, W-SU, Africa/Libreville, Asia/Tbilisi, America/Iqaluit, America/Pangnirtung, Etc/GMT+11, Antarctica/Casey, Europe/Copenhagen, Europe/Vatican, Asia/Karachi, Chile/Continental, America/Noronha, Europe/Tiraspol, America/Glace_Bay, America/Dawson_Creek, Asia/Singapore, Pacific/Noumea, Africa/Lusaka, Africa/Bissau, Pacific/Guadalcanal, Australia/Lindeman, Canada/Central, Asia/Oral, Japan, America/Hermosillo, Australia/South, America/Dominica, Europe/Athens, Europe/Luxembourg, Australia/Eucla, Asia/Ashgabat, Pacific/Kosrae, America/Sitka, Mexico/BajaNorte, Europe/Ljubljana, Asia/Irkutsk, Europe/Podgorica, Libya, Atlantic/South_Georgia, America/Argentina/San_Luis, Etc/GMT-8, Asia/Yakutsk, Indian/Christmas, US/East-Indiana, Etc/GMT+3, America/Indiana/Knox, Australia/Yancowinna, Europe/Busingen, Africa/Harare, Asia/Aden, Indian/Mahe, America/New_York, America/Chihuahua, ROC, America/Virgin, America/Vancouver, Europe/San_Marino, Hongkong, Europe/Kiev, Africa/Lubumbashi, Etc/GMT-14, America/Ensenada, Asia/Urumqi, America/Cancun, America/Whitehorse, Africa/Dar_es_Salaam, Etc/GMT-3, Indian/Cocos, America/Indiana/Petersburg, America/Kentucky/Monticello, Africa/Ndjamena, America/Boa_Vista, Europe/Tallinn, HST, Asia/Novokuznetsk, Asia/Makassar, Pacific/Pohnpei, CET
- guide_line:
- One of: ISEE_250Hz, Circulaire86, SS_4604861, DIN4150_3_80Hz, SN640312a, SS_025211, IN1226, SBR_A_2010, ONORM_S_9020, SBR_A_2017, NS_8141_1_2022, BS7385_250Hz, SBR_B_2002, UNE_22_381_93, DIN4150_2
- category (optional):
- One of: CAT3, CAT1, CAT2
- building_level:
- One of: industrialAndOfficeBuildings, USBM_RI8507_plaster, unspecified, OSMRE_1983, buildingClass1, freshConcrete, floorSlabs, dinFoundation, undergroundCavities, buildingClass5, highestFloor, residentialBuildings, buildingClass2, lowerLevel, selfDefined, USBM_RI8507_drywall, guidelineValues, buildingClass3, sensitiveBuildings, buildingClass4, heavyStructures, pipeline, foundation, structure
- flat_level:
- Only available when the building_level is set to unspecified.
This will be an absolute value as alarm level.
- vector_enabled:
- On, Off, setting it to On will store the PVS (peak vector sum)
and also trigger (non frequency dependend) alarms based on PVS.
- vdv_enabled:
- On, Off, setting it to On will calculate and store VDV (vibration dose value)
- atop_enabled:
- On, Off, setting it to On will calculate and store PPA (peak particle acceleration)
- vtop_enabled:
- On, Off, 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_Wf, ISO2631_Wc, BS6841_Wd, BS6841_Wf, BS6841_Wb, ISO2631_Wm, ISO8041_Wh, BS6841_Wc, ISO5349_Wh, ISO2631_We, BS6841_We, BS6841_Wg, ISO2631_Wd, ISO2631_Wk, ISO2631_Wj
- vdv_y:
- One of: ISO2631_Wf, ISO2631_Wc, BS6841_Wd, BS6841_Wf, BS6841_Wb, ISO2631_Wm, ISO8041_Wh, BS6841_Wc, ISO5349_Wh, ISO2631_We, BS6841_We, BS6841_Wg, ISO2631_Wd, ISO2631_Wk, ISO2631_Wj
- vdv_z:
- One of: ISO2631_Wf, ISO2631_Wc, BS6841_Wd, BS6841_Wf, BS6841_Wb, ISO2631_Wm, ISO8041_Wh, BS6841_Wc, ISO5349_Wh, ISO2631_We, BS6841_We, BS6841_Wg, ISO2631_Wd, ISO2631_Wk, ISO2631_Wj
- 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 lessThan2hours, moreThan15MPa, rc10MPaTo15MPa, lessThan10MPa
- vibration_source
- Used with IN 1226. One of vibratoryActivities, constructionActivities, mechanicalDevices, compaction, licensedQuarryAndMiningBlasting, pilingSheetingExcavation, blasting
- vibration_type:
- Needed with SBR, DIN 4150-3 and Circulaire86 measurements. One of repeated, longTerm, impulsive, peak, continually, continuous, shortTerm, momentarily
- 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_8m, H_2m, H_4m, H_6m, H_3m, H_1m, H_5m, H_7m
- lining_material:
- One of: reinforcedConcreteSteelWood, masonry, unreinforcedConcreteBrickEtc, materialClass3, reinforcedConcreteAndTubing, aeratedConcreteAndDelicateDetails, materialClass1, concreteAndStone, materialClass4, materialClass2
- construction_type:
- One of: sensitiveConstruction, resistantConstruction, designClass1, structureType1, designClass3, platformAndCatenaryPost, verySensitiveConstruction, structureType3, structureType2, designClass2
- pipeline_type:
- One of: weldedSteel, concreteAndSteel, brickworkAndPlastic
- 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",
}