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