Інструкція користувача

Sigfox Sensor Platform

Ця інструкція пояснює, як працювати з веб-інтерфейсом платформи: входити в систему, переглядати датчики, керувати групами, користувачами, Element-кімнатами та повідомленнями Sigfox.

Публічна частина інструкції доступна без авторизації. Адміністративні сторінки відкриваються тільки після входу в систему.

Перейти до сторінки входу

Зміст

1. Як працює система 2. Вхід у систему 3. Ролі користувачів 4. Основні сторінки 5. Датчики 6. Групи та Element 7. Користувачі 8. Повідомлення 9. Приклади роботи по ролях 10. Статуси та типові ситуації 11. Скріншоти для інструкції

1. Як працює система

Sigfox Sensor Platform приймає повідомлення від Sigfox Backend, зберігає їх у базі даних, показує в адміністративному інтерфейсі та може відправляти повідомлення в Element-кімнату.

Основна логіка:

1 датчик = 1 група = 1 Element-кімната = 1 Delta-шар через Signal Bot

Система напряму не керує Delta-шарами. Прив’язку Element-кімнати до Delta-шару виконує Signal Bot. Рекомендовано, щоб назва Element-кімнати збігалася з назвою Delta-шару — так користувачам простіше розуміти, куди надходять повідомлення.

Об’єкт	Що означає
Sensor / Датчик	Фізичний Sigfox-пристрій з унікальним Sigfox Device ID.
Group / Група	Об’єднує датчики, користувачів і одну Element-кімнату.
Element Room	Кімната Element/Matrix, куди система надсилає повідомлення з датчиків групи.
User / Користувач	Обліковий запис людини, яка має певну роль і доступ до груп.
Message / Повідомлення	Отримане повідомлення від Sigfox з даними датчика, координатами та статусом відправки в Element.

2. Вхід у систему

Відкрийте сторінку входу: /login.
Введіть ім’я користувача.
Введіть пароль.
Натисніть кнопку входу.
Після успішного входу відкриється сторінка Sensors.

Додайте скріншот: /guide/img/login.png

Рис. 1. Сторінка входу в систему

Якщо пароль втрачено, зверніться до адміністратора системи. Самостійне відновлення пароля може бути недоступне.

3. Ролі користувачів

Доступ у системі залежить від ролі. Є глобальна роль SUPER_ADMIN і ролі в межах конкретної групи: GROUP_ADMIN, OPERATOR, VIEWER.

Роль	Рівень доступу	Що може робити	Типові обмеження
SUPER_ADMIN	Вся система	Бачить усі групи, датчики, повідомлення, користувачів. Створює групи, користувачів, налаштовує Element.	Має максимальні права. Використовується тільки для адміністрування.
GROUP_ADMIN	Тільки свої групи	Керує датчиками та користувачами у своїй групі, може додавати OPERATOR/VIEWER.	Не бачить і не керує чужими групами.
OPERATOR	Тільки свої групи	Працює з датчиками та повідомленнями своєї групи.	Не керує користувачами та глобальними налаштуваннями.
VIEWER	Тільки свої групи	Переглядає датчики, групи та повідомлення.	Не створює, не редагує, не видаляє.

Один користувач може бути учасником кількох груп і мати різні ролі в різних групах. Наприклад: у групі North він може бути GROUP_ADMIN, а в групі South — VIEWER.

4. Основні сторінки системи

Сторінка	URL	Призначення	Кому доступна
Sensors	`/admin/sensors`	Перегляд, створення, редагування, вимкнення датчиків.	Залежить від ролі та групи.
Messages	`/admin/messages`	Перегляд отриманих Sigfox-повідомлень і статусу відправки в Element.	Залежить від ролі та групи.
Groups	`/admin/groups`	Керування групами, Element-кімнатами та статусом готовності груп.	SUPER_ADMIN, GROUP_ADMIN у своїх групах.
Group Users	`/admin/groups/{id}/users`	Користувачі конкретної групи та їх ролі.	SUPER_ADMIN, GROUP_ADMIN своєї групи.
Users	`/admin/users`	Створення користувачів, вмикання/вимикання, скидання пароля.	Переважно SUPER_ADMIN.
Change password	`/admin/profile/password`	Зміна власного пароля.	Усі авторизовані користувачі.

5. Робота з датчиками

Сторінка Sensors показує датчики, доступні поточному користувачу. Для SUPER_ADMIN це всі датчики системи. Для користувачів груп — тільки датчики їх груп.

Додайте скріншот: /guide/img/sensors.png

Рис. 2. Сторінка Sensors

Основні поля датчика

Поле	Пояснення	Приклад
Sigfox Device ID	Унікальний ID пристрою Sigfox. Має містити 8 HEX-символів.	`01FD456E`
Name	Зручна назва датчика.	`Sensor North 01`
Unit	Підрозділ або умовна назва групи користувачів.	`3 мб`
Responsible	Відповідальна особа.	`Іван`
Group	Група, якій належить датчик. Визначає доступ і Element-кімнату.	`North`
MGRS	Координати у форматі MGRS. Якщо введено MGRS, система може розрахувати Latitude/Longitude.	`37U CQ 60000 54614`
Latitude / Longitude	Географічні координати датчика.	`50.4501 / 30.5234`
Active	Якщо датчик вимкнений, він не використовується в нормальній роботі.	`true`

Додавання нового датчика

Відкрийте Sensors.
Натисніть Add sensor.
Введіть Sigfox Device ID.
Заповніть назву, підрозділ, відповідального та коментар.
Виберіть групу датчика.
Введіть координати як MGRS або Latitude/Longitude.
Натисніть Save.

Додайте скріншот: /guide/img/sensor-new.png

Рис. 3. Форма створення датчика

Один датчик має належати тільки одній активній групі. Щоб перенести датчик в іншу групу, змініть групу датчика або спочатку вимкніть стару прив’язку відповідно до правил системи.

6. Групи та налаштування Element

Група визначає, хто бачить датчики та повідомлення, а також у яку Element-кімнату надсилати повідомлення.

Додайте скріншот: /guide/img/groups.png

Рис. 4. Сторінка Groups

Коли група готова до відправки в Element

Група активна.
У групі є хоча б один GROUP_ADMIN.
Element sending enabled увімкнено.
Element room ID заповнений.

Поля налаштувань Element

Поле	Що означає	Приклад
Element room name / alias	Зручна назва кімнати. Рекомендовано вказувати назву, яка відповідає Delta-шару.	`North Layer`
Element room ID	Технічний Matrix Room ID. Зазвичай починається з `!`.	`!abcdef:matrix.server`
Element sending enabled	Дозволяє або забороняє відправку повідомлень цієї групи в Element.	`true`
Active	Вмикає або вимикає саму групу.	`true`

Додайте скріншот: /guide/img/group-settings.png

Рис. 5. Налаштування групи та Element-кімнати

Не публікуйте access token у відкритих каналах і не пересилайте його стороннім особам. Якщо token скомпрометовано, його потрібно замінити.

7. Користувачі та доступ до груп

Користувачі створюються окремо, а потім додаються в потрібні групи з відповідною роллю.

Додайте скріншот: /guide/img/users.png

Рис. 6. Сторінка Users

Додавання користувача в групу

Відкрийте сторінку Groups.
Виберіть потрібну групу.
Відкрийте Users або Group users.
Виберіть користувача.
Вкажіть роль: GROUP_ADMIN, OPERATOR або VIEWER.
Збережіть зміни.

Додайте скріншот: /guide/img/group-users.png

Рис. 7. Користувачі групи та їх ролі

Система захищає групу від ситуації, коли в ній не залишиться жодного GROUP_ADMIN. Тому останнього адміністратора групи не можна просто видалити або понизити без призначення іншого GROUP_ADMIN.

Додайте скріншот: /guide/img/user-groups.png

Рис. 8. Групи конкретного користувача

8. Повідомлення Sigfox

Сторінка Messages показує отримані повідомлення від Sigfox Backend. Тут можна перевірити, чи повідомлення було прийнято, оброблено та відправлено в Element.

Додайте скріншот: /guide/img/messages.png

Рис. 9. Сторінка Messages

Основні дані повідомлення

Поле	Пояснення
Sigfox Device ID	ID датчика, який надіслав повідомлення.
Time	Час повідомлення.
Data	Raw payload, отриманий від Sigfox.
Coordinates	Координати датчика або координати з налаштувань.
Element status	Показує, чи повідомлення було відправлене в Element.
Last error	Остання помилка обробки або пояснення, чому повідомлення очікує конфігурації.

Відповідь в Element

Відповідь доступна тільки для повідомлень, які вже були відправлені в Element і мають збережені Element room ID та Element event ID.

Якщо система показує повідомлення на кшталт Cannot reply: message has no Element room ID, це означає, що повідомлення ще не було відправлене в Element або це старе повідомлення без збереженого room ID.

9. Приклади роботи по ролях

SUPER_ADMIN — повне налаштування нової групи

Ситуація: потрібно створити нову групу датчиків і підключити її до Element.

Увійти як SUPER_ADMIN.
Відкрити Groups.
Створити групу, наприклад North.
Відкрити налаштування групи.
Вказати Element room name / alias.
Вказати Element room ID.
Увімкнути Element sending enabled.
Створити користувача ivan.
Додати ivan у групу North як GROUP_ADMIN.
Створити датчик 01FD456E і призначити його групі North.

Результат: повідомлення з датчика групи North будуть відправлятися в Element-кімнату цієї групи.

GROUP_ADMIN — керування своєю групою

Ситуація: адміністратор групи додає оператора та датчик.

Увійти як користувач з роллю GROUP_ADMIN у своїй групі.
Відкрити свою групу.
Перевірити, чи група активна і готова до Element.
Додати користувача в групу як OPERATOR або VIEWER.
Відкрити Sensors.
Додати або відредагувати датчик своєї групи.
Перевірити на сторінці Messages, чи надходять повідомлення.

Обмеження: GROUP_ADMIN працює тільки в межах своїх груп і не керує всією системою.

OPERATOR — робота з датчиками та повідомленнями

Ситуація: оператор перевіряє роботу датчиків.

Увійти як OPERATOR.
Відкрити Sensors і переглянути датчики своєї групи.
Перевірити активність датчиків і координати.
Відкрити Messages.
Перевірити останні повідомлення і статус відправки в Element.
Якщо повідомлення має статус WAITING CONFIG або ERROR, повідомити GROUP_ADMIN або SUPER_ADMIN.

Обмеження: OPERATOR не керує користувачами і не змінює глобальні налаштування.

VIEWER — тільки перегляд

Ситуація: користувачу потрібно тільки бачити стан датчиків і повідомлень.

Увійти як VIEWER.
Відкрити Sensors.
Переглянути датчики своєї групи.
Відкрити Messages.
Перевірити останні повідомлення та статуси.

Обмеження: VIEWER не створює, не редагує і не видаляє дані.

10. Статуси повідомлень та типові ситуації

Статус	Що означає	Що робити
SENT	Повідомлення успішно відправлено в Element.	Додаткових дій не потрібно.
NEW	Нове повідомлення прийняте і очікує обробки.	Зачекати, поки element-sender його обробить.
CHANGED	Повідомлення містить зміни і буде відправлене як оновлення.	Зачекати обробки.
WAITING CONFIG	Група або Element-кімната ще не налаштовані.	Перевірити групу: active, GROUP_ADMIN, Element sending enabled, room ID.
ERROR	Виникла технічна помилка під час відправки або обробки.	Перевірити Last error і звернутися до адміністратора.

Типові проблеми

Проблема	Причина	Рішення
Датчик не видно користувачу	Користувач не доданий у групу датчика або група неактивна.	Додати користувача в групу або перевірити статус групи.
Повідомлення не йде в Element	Не налаштований Element room ID або вимкнена відправка.	Відкрити Group Settings і перевірити налаштування Element.
Не можна видалити GROUP_ADMIN	Це останній GROUP_ADMIN у групі.	Спочатку призначити іншого GROUP_ADMIN.
Не працює відповідь в Element	У повідомлення немає Element room ID або event ID.	Дочекатися відправки повідомлення в Element або перевірити старі повідомлення.
Неправильні координати	Помилка у MGRS або Latitude/Longitude.	Перевірити формат координат і зберегти датчик ще раз.

Коротка пам’ятка

SUPER_ADMIN налаштовує всю систему.
GROUP_ADMIN керує своєю групою.
OPERATOR працює з датчиками та повідомленнями своєї групи.
VIEWER тільки переглядає інформацію.
Датчик має бути прив’язаний до групи.
Група має мати Element room ID, якщо потрібна відправка в Element.
Для кожної групи має бути хоча б один GROUP_ADMIN.

Версія інструкції: 1.0. Дата: 07.07.2026.