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