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