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