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