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