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