Appearance
MQTT
Настройки драйвера
ts
export const MQTTSettingsSchema = z.object({
settings: z.object({
/** IP-адрес MQTT-брокера. */
IP: nonEmptyString(t("shared_text.ip_required")),
/** Порт MQTT-брокера. */
Port: nonEmptyString(t("shared_text.port_required")),
/** Логин для авторизации на брокере (пустая строка — без авторизации). */
Login: z.string(),
/** Пароль для авторизации на брокере (пустая строка — без авторизации). */
Password: z.string(),
/** Явная подписка на топики при подключении. */
ExplicitSubscribe: z.boolean(),
/** Количество повторных попыток при сбое. */
RetriesCount: z.number(),
/** Интервал между повторными попытками (миллисекунды). */
RetryIntervalMs: z.number(),
}),
});Настройки связи
Справочник полей настроек связи (link.settings): ключ в БД, лейбл редактора, доступы, при которых поле видно в редакторе и уходит в запрос контроллеру, и дефолт нового линка. Хранятся настройки всегда целиком — доступ определяет только видимость полей и состав запроса.
| Ключ | Настройка | Чт. | Зап. | Дефолт |
|---|---|---|---|---|
TEXTAREA | топик | ✓ | ✓ | "" |
TIMEOUT_SEC | таймаут, сек | ✓ | — | "1800" |
RETAIN_HANDLING | обработка удерживаемых сообщений | ✓ | — | "0" |
QOS | приоритет | — | ✓ | "0" |
NO_LOCAL_FLAG | без локальной доставки | — | ✓ | false |
RETAIN_AS_PUBLISHED | сохранить в опубликованном виде | — | ✓ | false |
NO_DATA_ENABLED | значение при отсутствии данных | ✓ | — | false |
NO_DATA_VALUE | подставляемое значение | ✓ | — | "" |
Типы
ts
export const mqttLinkSettingsSchema = z
.object({
[EDriverSettingsType.TEXTAREA]: MQTT_LINK_SETTINGS_SHAPE.TEXTAREA.optional(),
[EDriverSettingsType.TIMEOUT_SEC]: MQTT_LINK_SETTINGS_SHAPE.TIMEOUT_SEC.optional(),
[EDriverSettingsType.RETAIN_HANDLING]:
MQTT_LINK_SETTINGS_SHAPE.RETAIN_HANDLING.optional(),
[EDriverSettingsType.QOS]: MQTT_LINK_SETTINGS_SHAPE.QOS.optional(),
[EDriverSettingsType.NO_LOCAL_FLAG]:
MQTT_LINK_SETTINGS_SHAPE.NO_LOCAL_FLAG.optional(),
[EDriverSettingsType.RETAIN_AS_PUBLISHED]:
MQTT_LINK_SETTINGS_SHAPE.RETAIN_AS_PUBLISHED.optional(),
[EDriverSettingsType.NO_DATA_ENABLED]:
MQTT_LINK_SETTINGS_SHAPE.NO_DATA_ENABLED.optional(),
[EDriverSettingsType.NO_DATA_VALUE]:
MQTT_LINK_SETTINGS_SHAPE.NO_DATA_VALUE.optional(),
})
.strict()
.superRefine((settings, ctx) => {
if (settings.TEXTAREA !== undefined && !settings.TEXTAREA.startsWith("/")) {
ctx.addIssue({
code: z.ZodIssueCode.custom,
message: t("shared_text.MQTT_slash"),
path: [EDriverSettingsType.TEXTAREA],
});
}
});Стратегия импорта
О том что такое стратегия импорта можно почитать здесь Таб импорта в драйверах
Зависимость objectType от поля type
ts
const getObjectSettingsTypeFromMQTT = (
type: string,
): { type: EObjectType; settings: any } | undefined => {
switch (type) {
case "AI":
return { type: EObjectType.ANALOG_INPUT, settings: defaultAnalogInputSettings };
case "AO":
return { type: EObjectType.ANALOG_OUTPUT, settings: defaultAnalogOutputSettings };
case "DI":
return { type: EObjectType.DIGITAL_INPUT, settings: defaultDigitalInputSettings };
case "DO":
return { type: EObjectType.DIGITAL_OUTPUT, settings: defaultDigitalOutputSettings };
case "M":
return { type: EObjectType.MODE_OBJECT, settings: defaultModeObjectSettings };
default:
return undefined;
}
};
ts
const getObjectDisplayFromMQTT = (
type: string,
csvRow: ICSVObject,
): ObjectDisplay | null => {
let displayToImport: ObjectDisplay | null = null;
switch (type) {
case "AI":
displayToImport = { ...defaultAnalogInputObjectDisplay };
break;
case "AO":
displayToImport = { ...defaultAnalogOutputObjectDisplay };
break;
case "DI":
displayToImport = { ...defaultDigitalInputObjectDisplay };
break;
case "DO":
displayToImport = { ...defaultDigitalOutputObjectDisplay };
break;
case "M":
displayToImport = { ...defaultModeObjectDisplay };
break;
default:
return null;
}
if (displayToImport.name !== csvRow["#keyname"]) {
displayToImport.isNameTech = false;
displayToImport.isDescTech = false;
}
displayToImport.name = csvRow["name_translated"] || "";
displayToImport.description = csvRow["description_translated"] || "";
displayToImport.unit = bacnetUnitCodeReverseMap[csvRow["unit-code"]];
return displayToImport;
};Зависимость driverSettings от additionalData
ts
async updateDriverData({ additionalInfo, currentObject }): Promise<{
objectsToUpdate?: UpdateObjectDto;
}> {
// Обновляем настройки самого драйвера (не driverLink)
const driverSettings = { ...currentObject.settings };
if (additionalInfo?.IP) {
driverSettings.IP = additionalInfo.IP;
}
if (additionalInfo?.PORT) {
driverSettings.Port = additionalInfo.PORT;
}
if (additionalInfo?.LOGIN) {
driverSettings.Login = additionalInfo.LOGIN;
}
if (additionalInfo?.PASSWORD) {
driverSettings.Password = additionalInfo.PASSWORD;
}
const updatedObject: UpdateObjectDto = {
id: currentObject.id,
settings: {
...currentObject.settings,
...driverSettings,
},
};
return {
objectsToUpdate: updatedObject,
};
},Зависимость driverLink.type от settable
ts
const getDriverLinkTypeFromSettable = (settable: string | undefined): EDriverLinkType => {
// Если settable === "Y" - WRITE, иначе READ
return !!settable && settable === "Y" ? EDriverLinkType.WRITE : EDriverLinkType.READ;
};Mentioned In
None yet.