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