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