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