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