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