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