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