├── .editorconfig ├── .gitattributes ├── .github ├── FUNDING.yml ├── ISSUE_TEMPLATE │ ├── bug_report.yml │ ├── config.yml │ └── feature_request.yml ├── actions │ └── install-redis-linux │ │ └── action.yml ├── auto-merge.yml ├── dependabot.yml ├── pull_request_template.md └── workflows │ ├── auto-approve-nightly.yml │ ├── ci-tests.yml │ ├── codeql.yml │ ├── dependabot-automerge.yml │ ├── nightly-dev-release.yml │ └── official-release.yml ├── .gitignore ├── .mocharc.json ├── .nvmrc ├── .prettierignore ├── .releaseconfig.json ├── .vscode └── settings.json ├── CHANGELOG.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── eslint.config.mjs ├── iobroker.png ├── lerna.json ├── nx.json ├── package-lock.json ├── package.json ├── packages ├── adapter │ ├── LICENSE │ ├── README.md │ ├── package.json │ ├── src │ │ ├── cert │ │ │ └── cloudCert.crt │ │ ├── index.ts │ │ └── lib │ │ │ ├── _Types.ts │ │ │ └── adapter │ │ │ ├── adapter.ts │ │ │ ├── constants.ts │ │ │ ├── defaultObjs.ts │ │ │ ├── log.ts │ │ │ ├── userInterfaceMessagingController.ts │ │ │ ├── utils.ts │ │ │ └── validator.ts │ ├── tsconfig.build.json │ └── tsconfig.json ├── cli │ ├── LICENSE │ ├── README.md │ ├── package.json │ ├── src │ │ ├── index.ts │ │ └── lib │ │ │ ├── _Types.ts │ │ │ ├── cli │ │ │ ├── cliCert.ts │ │ │ ├── cliCommand.ts │ │ │ ├── cliCompact.ts │ │ │ ├── cliDebug.ts │ │ │ ├── cliHost.ts │ │ │ ├── cliLogs.ts │ │ │ ├── cliMessage.ts │ │ │ ├── cliObjects.ts │ │ │ ├── cliPlugin.ts │ │ │ ├── cliProcess.ts │ │ │ ├── cliStates.ts │ │ │ ├── cliTools.ts │ │ │ └── messages.ts │ │ │ ├── setup.ts │ │ │ └── setup │ │ │ ├── customError.ts │ │ │ ├── dbConnection.ts │ │ │ ├── formatters.ts │ │ │ ├── multihostClient.ts │ │ │ ├── pluginInfos.ts │ │ │ ├── setupBackup.ts │ │ │ ├── setupInstall.ts │ │ │ ├── setupLicense.ts │ │ │ ├── setupList.ts │ │ │ ├── setupMultihost.ts │ │ │ ├── setupPacketManager.ts │ │ │ ├── setupRepo.ts │ │ │ ├── setupSetup.ts │ │ │ ├── setupUpgrade.ts │ │ │ ├── setupUpload.ts │ │ │ ├── setupUsers.ts │ │ │ ├── setupVendor.ts │ │ │ ├── setupVisDebug.ts │ │ │ └── utils.ts │ ├── tsconfig.build.json │ └── tsconfig.json ├── common-db │ ├── LICENSE │ ├── README.md │ ├── package.json │ ├── src │ │ ├── index.ts │ │ └── lib │ │ │ ├── common │ │ │ ├── aliasProcessing.ts │ │ │ ├── constants.ts │ │ │ ├── exitCodes.ts │ │ │ ├── interview.ts │ │ │ ├── logger.ts │ │ │ ├── maybeCallback.test.ts │ │ │ ├── maybeCallback.ts │ │ │ ├── password.ts │ │ │ ├── session.ts │ │ │ └── tools.ts │ │ │ └── types.d.ts │ ├── tsconfig.build.json │ └── tsconfig.json ├── common │ ├── LICENSE │ ├── README.md │ ├── package.json │ ├── src │ │ ├── index.ts │ │ └── lib │ │ │ └── common │ │ │ ├── notificationHandler.ts │ │ │ ├── objects.ts │ │ │ ├── states.ts │ │ │ ├── tools.ts │ │ │ └── zipFiles.ts │ ├── tsconfig.build.json │ └── tsconfig.json ├── controller │ ├── LICENSE │ ├── README.md │ ├── conf │ │ └── iobroker-dist.json │ ├── controller.js │ ├── doc │ │ ├── -internal- │ │ │ ├── README.md │ │ │ ├── classes │ │ │ │ ├── Log.md │ │ │ │ ├── ObjectsInRedisClient.md │ │ │ │ ├── StateRedisClient.md │ │ │ │ ├── UserInterfaceMessagingController.md │ │ │ │ └── Validator.md │ │ │ ├── enumerations │ │ │ │ └── STATE_QUALITY.md │ │ │ ├── interfaces │ │ │ │ ├── ACLObject.md │ │ │ │ ├── AdapterCommon.md │ │ │ │ ├── AdapterConfig.md │ │ │ │ ├── AdapterObject.md │ │ │ │ ├── AdapterOptions.md │ │ │ │ ├── AdapterOptionsConfig.md │ │ │ │ ├── AdminUi.md │ │ │ │ ├── AliasDetails.md │ │ │ │ ├── AliasDetailsSource.md │ │ │ │ ├── AliasTargetEntry.md │ │ │ │ ├── BackupOptions.md │ │ │ │ ├── BaseObject.md │ │ │ │ ├── CallOptions.md │ │ │ │ ├── Certificates.md │ │ │ │ ├── ChannelCommon.md │ │ │ │ ├── ChannelObject.md │ │ │ │ ├── ChartCommon.md │ │ │ │ ├── ChartObject.md │ │ │ │ ├── CheckStatesResult.md │ │ │ │ ├── ChownFileResult.md │ │ │ │ ├── ClientHandler.md │ │ │ │ ├── ConnectionOptions.md │ │ │ │ ├── CustomAdminColumn.md │ │ │ │ ├── DatabaseBackupOptions.md │ │ │ │ ├── DatabaseOptions.md │ │ │ │ ├── DbStatus.md │ │ │ │ ├── DelObjectOptions.md │ │ │ │ ├── DesignObject.md │ │ │ │ ├── DeviceCommon.md │ │ │ │ ├── DeviceObject.md │ │ │ │ ├── EnumCommon.md │ │ │ │ ├── EnumObject.md │ │ │ │ ├── EvaluatedFileACL.md │ │ │ │ ├── ExtendObjectOptions.md │ │ │ │ ├── ExtendObjectOptionsPreserve.md │ │ │ │ ├── FileACL.md │ │ │ │ ├── FolderObject.md │ │ │ │ ├── GetHistoryOptions.md │ │ │ │ ├── GetObjectListItem.md │ │ │ │ ├── GetObjectViewItem.md │ │ │ │ ├── GetObjectViewParams.md │ │ │ │ ├── GetUserGroupsOptions.md │ │ │ │ ├── GroupCommon.md │ │ │ │ ├── GroupObject.md │ │ │ │ ├── HeartbeatTimer.md │ │ │ │ ├── HostCommon.md │ │ │ │ ├── HostNative.md │ │ │ │ ├── HostObject.md │ │ │ │ ├── IdObject.md │ │ │ │ ├── InstallNodeModuleOptions.md │ │ │ │ ├── InstanceCommon.md │ │ │ │ ├── InstanceObject.md │ │ │ │ ├── InternalAdapterJsonConfig.md │ │ │ │ ├── InternalAddChannelToEnumOptions.md │ │ │ │ ├── InternalAddStateToEnumOptions.md │ │ │ │ ├── InternalCalculatePermissionsOptions.md │ │ │ │ ├── InternalCheckGroupOptions.md │ │ │ │ ├── InternalCheckPasswordOptions.md │ │ │ │ ├── InternalCreateDeviceOptions.md │ │ │ │ ├── InternalCreateStateOptions.md │ │ │ │ ├── InternalDelObjectOptions.md │ │ │ │ ├── InternalDelStateOptions.md │ │ │ │ ├── InternalDeleteChannelFromEnumOptions.md │ │ │ │ ├── InternalDeleteChannelOptions.md │ │ │ │ ├── InternalDeleteDeviceOptions.md │ │ │ │ ├── InternalDeleteStateFromEnumOptions.md │ │ │ │ ├── InternalDeleteStateOptions.md │ │ │ │ ├── InternalDestroySessionOptions.md │ │ │ │ ├── InternalFormatDateOptions.md │ │ │ │ ├── InternalGetAdapterObjectsOptions.md │ │ │ │ ├── InternalGetCertificatesOptions.md │ │ │ │ ├── InternalGetChannelsOfOptions.md │ │ │ │ ├── InternalGetDevicesOptions.md │ │ │ │ ├── InternalGetEncryptedConfigOptions.md │ │ │ │ ├── InternalGetEnumOptions.md │ │ │ │ ├── InternalGetEnumsOptions.md │ │ │ │ ├── InternalGetHistoryOptions.md │ │ │ │ ├── InternalGetObjectOptions.md │ │ │ │ ├── InternalGetObjectViewOptions.md │ │ │ │ ├── InternalGetObjectsOptions.md │ │ │ │ ├── InternalGetPortOptions.md │ │ │ │ ├── InternalGetSessionOptions.md │ │ │ │ ├── InternalGetStateOptions.md │ │ │ │ ├── InternalGetStatesOfOptions.md │ │ │ │ ├── InternalGetStatesOptions.md │ │ │ │ ├── InternalGetUserIDOptions.md │ │ │ │ ├── InternalInstallNodeModuleOptions.md │ │ │ │ ├── InternalReportDeprecationOption.md │ │ │ │ ├── InternalSendToHostOptions.md │ │ │ │ ├── InternalSendToOptions.md │ │ │ │ ├── InternalSetObjectOptions.md │ │ │ │ ├── InternalSetPasswordOptions.md │ │ │ │ ├── InternalSetSessionOptions.md │ │ │ │ ├── InternalSetStateChangedOptions.md │ │ │ │ ├── InternalSetStateOptions.md │ │ │ │ ├── InternalStopParameters.md │ │ │ │ ├── InternalSubscribeOptions.md │ │ │ │ ├── InternalUpdateConfigOptions.md │ │ │ │ ├── IoBJson.md │ │ │ │ ├── JsonlOptions.md │ │ │ │ ├── LicenseInformationFree.md │ │ │ │ ├── LicenseInformationWithPayment.md │ │ │ │ ├── LogMessage.md │ │ │ │ ├── Logger.md │ │ │ │ ├── Message.md │ │ │ │ ├── MessageCallbackInfo.md │ │ │ │ ├── MessageCallbackObject.md │ │ │ │ ├── MessageRule.md │ │ │ │ ├── MessagingControllerOptions.md │ │ │ │ ├── MetaCommon.md │ │ │ │ ├── MetaObject.md │ │ │ │ ├── NonEditable.md │ │ │ │ ├── Notification.md │ │ │ │ ├── NotificationContextData.md │ │ │ │ ├── NotificationOptions.md │ │ │ │ ├── NotificationScopes.md │ │ │ │ ├── ObjectACL.md │ │ │ │ ├── ObjectCommon.md │ │ │ │ ├── ObjectOperationPermissions.md │ │ │ │ ├── ObjectPermissions.md │ │ │ │ ├── ObjectsDatabaseOptions.md │ │ │ │ ├── ObjectsSettings.md │ │ │ │ ├── Options.md │ │ │ │ ├── OtherCommon.md │ │ │ │ ├── OtherObject.md │ │ │ │ ├── PartialAdapterObject.md │ │ │ │ ├── PartialChannelObject.md │ │ │ │ ├── PartialDesignObject.md │ │ │ │ ├── PartialDeviceObject.md │ │ │ │ ├── PartialEnumObject.md │ │ │ │ ├── PartialFolderObject.md │ │ │ │ ├── PartialGroupObject.md │ │ │ │ ├── PartialHostObject.md │ │ │ │ ├── PartialInstanceObject.md │ │ │ │ ├── PartialMetaObject.md │ │ │ │ ├── PartialOtherObject.md │ │ │ │ ├── PartialRepositoryObject.md │ │ │ │ ├── PartialScheduleObject.md │ │ │ │ ├── PartialScriptObject.md │ │ │ │ ├── PartialStateObject.md │ │ │ │ ├── PartialSystemConfigObject.md │ │ │ │ ├── PartialUserObject.md │ │ │ │ ├── PermissionSet.md │ │ │ │ ├── ReadDirResult.md │ │ │ │ ├── RedisConnectionOptions.md │ │ │ │ ├── RepoInfo.md │ │ │ │ ├── RepositoryCommon.md │ │ │ │ ├── RepositoryInformation.md │ │ │ │ ├── RepositoryJson.md │ │ │ │ ├── RepositoryJsonAdapterContent.md │ │ │ │ ├── RepositoryObject.md │ │ │ │ ├── RmResult.md │ │ │ │ ├── ScheduleCommon.md │ │ │ │ ├── ScheduleObject.md │ │ │ │ ├── ScriptCommon.md │ │ │ │ ├── ScriptObject.md │ │ │ │ ├── SendToClientOptions.md │ │ │ │ ├── SendToOptions.md │ │ │ │ ├── SendToUserInterfaceClientOptions.md │ │ │ │ ├── SendableMessage.md │ │ │ │ ├── SetStateChangedResult.md │ │ │ │ ├── State.md │ │ │ │ ├── StateACL.md │ │ │ │ ├── StateCommon.md │ │ │ │ ├── StateObject.md │ │ │ │ ├── StatesDatabaseOptions.md │ │ │ │ ├── StatesSettings.md │ │ │ │ ├── StopParameters.md │ │ │ │ ├── SupportedMessages.md │ │ │ │ ├── SystemConfigCommon.md │ │ │ │ ├── SystemConfigObject.md │ │ │ │ ├── UserCommon.md │ │ │ │ ├── UserInterfaceClientSubscribeReturnType.md │ │ │ │ ├── UserInterfaceSubscribeInfo.md │ │ │ │ ├── UserObject.md │ │ │ │ ├── ValidateIdOptions.md │ │ │ │ ├── VisWidget.md │ │ │ │ └── WriteFileOptions.md │ │ │ └── type-aliases │ │ │ │ ├── Adapter.md │ │ │ │ ├── AdapterScopedObject.md │ │ │ │ ├── AnyObject.md │ │ │ │ ├── AnyPartialObject.md │ │ │ │ ├── AtLeastOne.md │ │ │ │ ├── AutoUpgradePolicy.md │ │ │ │ ├── Brand.md │ │ │ │ ├── Branded.md │ │ │ │ ├── CalculatePermissionsCallback.md │ │ │ │ ├── Callback.md │ │ │ │ ├── CallbackReturnTypeOf.md │ │ │ │ ├── ChangeFunction.md │ │ │ │ ├── Channel.md │ │ │ │ ├── CheckFileCallback.md │ │ │ │ ├── CheckFileRightsCallback.md │ │ │ │ ├── CheckGroupCallback.md │ │ │ │ ├── CheckPasswordCallback.md │ │ │ │ ├── CheckStateCommand.md │ │ │ │ ├── ChownFileCallback.md │ │ │ │ ├── ChownObjectCallback.md │ │ │ │ ├── ClientUnsubscribeReason.md │ │ │ │ ├── CommandsPermissions.md │ │ │ │ ├── CommandsPermissionsEntry.md │ │ │ │ ├── CommandsPermissionsObject.md │ │ │ │ ├── CommonType.md │ │ │ │ ├── ConnectionType.md │ │ │ │ ├── DeleteStateCallback.md │ │ │ │ ├── Dependencies.md │ │ │ │ ├── EmptyCallback.md │ │ │ │ ├── Enum.md │ │ │ │ ├── EnumList.md │ │ │ │ ├── ErrnoCallback.md │ │ │ │ ├── ErrorCallback.md │ │ │ │ ├── ErrorHandler.md │ │ │ │ ├── ExtendObjectCallback.md │ │ │ │ ├── FileChangeHandler.md │ │ │ │ ├── FindObjectCallback.md │ │ │ │ ├── GenericCallback.md │ │ │ │ ├── GetCertificatesCallback.md │ │ │ │ ├── GetCertificatesPromiseReturnType.md │ │ │ │ ├── GetEncryptedConfigCallback.md │ │ │ │ ├── GetEnumCallback.md │ │ │ │ ├── GetEnumsCallback.md │ │ │ │ ├── GetEnumsPromise.md │ │ │ │ ├── GetHistoryCallback.md │ │ │ │ ├── GetHistoryResult.md │ │ │ │ ├── GetKeysCallback.md │ │ │ │ ├── GetObjectCallback.md │ │ │ │ ├── GetObjectListCallback.md │ │ │ │ ├── GetObjectListPromise.md │ │ │ │ ├── GetObjectPromise.md │ │ │ │ ├── GetObjectViewCallback.md │ │ │ │ ├── GetObjectViewPromise.md │ │ │ │ ├── GetObjectsCallback.md │ │ │ │ ├── GetObjectsCallback3.md │ │ │ │ ├── GetObjectsCallbackTyped.md │ │ │ │ ├── GetObjectsPromise.md │ │ │ │ ├── GetObjectsPromiseTyped.md │ │ │ │ ├── GetSessionCallback.md │ │ │ │ ├── GetStateCallback.md │ │ │ │ ├── GetStatePromise.md │ │ │ │ ├── GetStatesCallback.md │ │ │ │ ├── GetStatesPromise.md │ │ │ │ ├── GetUserGroupCallbackNoError.md │ │ │ │ ├── GetUserGroupPromiseReturn.md │ │ │ │ ├── Group.md │ │ │ │ ├── InferGetObjectViewItemType.md │ │ │ │ ├── InstalledFrom.md │ │ │ │ ├── Instance.md │ │ │ │ ├── InstanceMode.md │ │ │ │ ├── InternalLogger.md │ │ │ │ ├── Interval.md │ │ │ │ ├── IoBrokerJson.md │ │ │ │ ├── Languages.md │ │ │ │ ├── LicenseInformation.md │ │ │ │ ├── LocalLink.md │ │ │ │ ├── LogFunction.md │ │ │ │ ├── LogLevel.md │ │ │ │ ├── LogMessageInternal.md │ │ │ │ ├── MaybePromise.md │ │ │ │ ├── MessageCallback.md │ │ │ │ ├── MessageHandler.md │ │ │ │ ├── MessageUnsubscribeReason.md │ │ │ │ ├── Meta.md │ │ │ │ ├── Misc.md │ │ │ │ ├── NonNullCallbackReturnTypeOf.md │ │ │ │ ├── NotificationCategory.md │ │ │ │ ├── Object.md │ │ │ │ ├── ObjectChangeHandler.md │ │ │ │ ├── ObjectIdToObjectType.md │ │ │ │ ├── ObjectType.md │ │ │ │ ├── OptionalCallback.md │ │ │ │ ├── PaidLicenseType.md │ │ │ │ ├── PartialChartObject.md │ │ │ │ ├── PartialObjectWorker.md │ │ │ │ ├── Pattern.md │ │ │ │ ├── Plugin.md │ │ │ │ ├── ReadDirCallback.md │ │ │ │ ├── ReadDirPromise.md │ │ │ │ ├── ReadFileCallback.md │ │ │ │ ├── ReadFilePromise.md │ │ │ │ ├── ReadyHandler.md │ │ │ │ ├── RmCallback.md │ │ │ │ ├── ScriptOrChannel.md │ │ │ │ ├── SecondParameterOf.md │ │ │ │ ├── SendToAllClientOptions.md │ │ │ │ ├── Session.md │ │ │ │ ├── SetObjectCallback.md │ │ │ │ ├── SetObjectPromise.md │ │ │ │ ├── SetStateCallback.md │ │ │ │ ├── SetStateChangedCallback.md │ │ │ │ ├── SetStateChangedPromise.md │ │ │ │ ├── SetStatePromise.md │ │ │ │ ├── SettableObjectWorker.md │ │ │ │ ├── SettableState.md │ │ │ │ ├── State.md │ │ │ │ ├── StateChangeHandler.md │ │ │ │ ├── StateValue.md │ │ │ │ ├── StringOrTranslated.md │ │ │ │ ├── Timeout.md │ │ │ │ ├── TimeoutCallback.md │ │ │ │ ├── Translated.md │ │ │ │ ├── UnloadHandler.md │ │ │ │ ├── User.md │ │ │ │ ├── UserChangeFunction.md │ │ │ │ ├── UserInterfaceClientRemoveMessage.md │ │ │ │ ├── UserInterfaceClientSubscribeHandler.md │ │ │ │ ├── UserInterfaceClientUnsubscribeHandler.md │ │ │ │ ├── UserInterfaceClientUnsubscribeReason.md │ │ │ │ ├── UserInterfaceUnsubscribeInfo.md │ │ │ │ ├── UserInterfaceUnsubscribeInfoBaseObject.md │ │ │ │ └── WelcomeScreenEntry.md │ │ ├── README.md │ │ ├── classes │ │ │ └── AdapterClass.md │ │ ├── globals.md │ │ └── variables │ │ │ └── Adapter.md │ ├── io-package.json │ ├── iobroker.js │ ├── package.json │ ├── src │ │ ├── compactgroupController.ts │ │ ├── lib │ │ │ ├── adapter.ts │ │ │ ├── adapterAutoUpgradeManager.ts │ │ │ ├── adapterUpgradeManager.ts │ │ │ ├── blocklistManager.ts │ │ │ ├── exitCodes.ts │ │ │ ├── multihostServer.ts │ │ │ ├── objects.ts │ │ │ ├── objects │ │ │ │ ├── objectsInMemClient.ts │ │ │ │ └── objectsInMemServer.ts │ │ │ ├── password.ts │ │ │ ├── preinstallCheck.ts │ │ │ ├── restart.ts │ │ │ ├── states │ │ │ │ ├── statesInMemClient.ts │ │ │ │ └── statesInMemServer.ts │ │ │ ├── tools.ts │ │ │ ├── types.d.ts │ │ │ ├── upgradeManager.ts │ │ │ ├── utils.ts │ │ │ └── vis │ │ │ │ ├── states.ts │ │ │ │ └── visUtils.ts │ │ └── main.ts │ ├── test │ │ ├── _Types.ts │ │ ├── jsonl │ │ │ ├── testAdapterObjectsInFileJsonl.ts │ │ │ └── testAdapterStatesInFilesJsonl.ts │ │ ├── lib │ │ │ ├── io-package.json │ │ │ ├── objects.json │ │ │ ├── package.json │ │ │ ├── permissions.ts │ │ │ ├── setup4controller.ts │ │ │ ├── states.json │ │ │ ├── testAdapter.ts │ │ │ ├── testAdapterHelpers.ts │ │ │ ├── testAliases.ts │ │ │ ├── testConsole.ts │ │ │ ├── testEnums.ts │ │ │ ├── testFiles.ts │ │ │ ├── testHelperStates.ts │ │ │ ├── testMessages.ts │ │ │ ├── testObjects.ts │ │ │ ├── testObjectsACL.ts │ │ │ ├── testObjectsFunctions.ts │ │ │ └── testStates.ts │ │ ├── redis-sentinel │ │ │ ├── .gitignore │ │ │ ├── config │ │ │ │ ├── redis1.config │ │ │ │ ├── redis2.config │ │ │ │ ├── redis3.config │ │ │ │ ├── sentinel1.config │ │ │ │ ├── sentinel2.config │ │ │ │ └── sentinel3.config │ │ │ ├── setup-sentinel-cleanup.sh │ │ │ ├── setup-sentinel-start.sh │ │ │ ├── setup-sentinel-stop.sh │ │ │ ├── test-sentinel.sh │ │ │ ├── testAdapterStatesRedis.ts │ │ │ └── testStatesRedis.ts │ │ ├── redis-socket │ │ │ ├── redis-socket.config │ │ │ ├── setup-socket.sh │ │ │ ├── testAdapterStatesRedis.ts │ │ │ └── testStatesRedis.ts │ │ ├── testAdapterObjectsInFile.ts │ │ ├── testAdapterObjectsInRedis.ts │ │ ├── testAdapterStatesInFile.ts │ │ ├── testAdapterStatesRedis.ts │ │ ├── testInternalUtilities.ts │ │ ├── testPackageFiles.ts │ │ ├── testStates.ts │ │ ├── testStatesRedis.ts │ │ └── testTools.ts │ ├── tsconfig.build.json │ ├── tsconfig.check.json │ └── tsconfig.json ├── db-base │ ├── LICENSE │ ├── README.md │ ├── package.json │ ├── src │ │ ├── index.ts │ │ └── lib │ │ │ ├── constants.ts │ │ │ ├── inMemFileDB.ts │ │ │ └── redisHandler.ts │ ├── tsconfig.build.json │ └── tsconfig.json ├── db-objects-file │ ├── LICENSE │ ├── README.md │ ├── package.json │ ├── src │ │ ├── index.ts │ │ └── lib │ │ │ └── objects │ │ │ ├── objectsInMemFileDB.js │ │ │ ├── objectsInMemServerClass.js │ │ │ └── objectsInMemServerRedis.js │ ├── tsconfig.build.json │ └── tsconfig.json ├── db-objects-jsonl │ ├── LICENSE │ ├── README.md │ ├── package.json │ ├── src │ │ ├── index.ts │ │ └── lib │ │ │ └── objects │ │ │ ├── objectsInMemJsonlDB.js │ │ │ ├── objectsInMemServerClass.js │ │ │ └── objectsInMemServerRedis.js │ ├── tsconfig.build.json │ └── tsconfig.json ├── db-objects-redis │ ├── CHANGELOG_OLD.md │ ├── LICENSE │ ├── README.md │ ├── package.json │ ├── src │ │ ├── index.ts │ │ └── lib │ │ │ └── objects │ │ │ ├── constants.ts │ │ │ ├── interview.ts │ │ │ ├── lua-v3 │ │ │ ├── custom.lua │ │ │ ├── filter.lua │ │ │ ├── programs.lua │ │ │ ├── script.lua │ │ │ └── variables.lua │ │ │ ├── lua-v4-no-sets │ │ │ ├── custom.lua │ │ │ ├── filter.lua │ │ │ ├── programs.lua │ │ │ ├── redlock_acquire.lua │ │ │ ├── redlock_extend.lua │ │ │ ├── redlock_release.lua │ │ │ ├── script.lua │ │ │ └── variables.lua │ │ │ ├── lua-v4 │ │ │ ├── custom.lua │ │ │ ├── filter.lua │ │ │ ├── programs.lua │ │ │ ├── redlock_acquire.lua │ │ │ ├── redlock_extend.lua │ │ │ ├── redlock_release.lua │ │ │ ├── script.lua │ │ │ └── variables.lua │ │ │ ├── objectsInRedisClient.ts │ │ │ └── objectsUtils.ts │ ├── tsconfig.build.json │ └── tsconfig.json ├── db-states-file │ ├── LICENSE │ ├── README.md │ ├── package.json │ ├── src │ │ ├── index.ts │ │ └── lib │ │ │ └── states │ │ │ ├── statesInMemFileDB.js │ │ │ ├── statesInMemServerClass.js │ │ │ └── statesInMemServerRedis.js │ ├── tsconfig.build.json │ └── tsconfig.json ├── db-states-jsonl │ ├── LICENSE │ ├── README.md │ ├── package.json │ ├── src │ │ ├── index.ts │ │ └── lib │ │ │ └── states │ │ │ ├── statesInMemJsonlDB.js │ │ │ ├── statesInMemServerClass.js │ │ │ └── statesInMemServerRedis.js │ ├── tsconfig.build.json │ └── tsconfig.json ├── db-states-redis │ ├── LICENSE │ ├── README.md │ ├── package.json │ ├── src │ │ ├── index.ts │ │ └── lib │ │ │ └── states │ │ │ ├── interview.ts │ │ │ └── statesInRedisClient.ts │ ├── tsconfig.build.json │ └── tsconfig.json ├── types-dev │ ├── LICENSE │ ├── README.md │ ├── config.d.ts │ ├── index.d.ts │ ├── objects.d.ts │ ├── package.json │ └── utils.d.ts └── types-public │ ├── LICENSE │ ├── README.md │ ├── api-extractor.json │ ├── build.ts │ ├── index.d.ts │ ├── index.js │ ├── index.test-d.ts │ ├── package.json │ └── public.d.ts ├── prettier.config.mjs ├── schemas ├── io-package.json ├── iobroker.json └── updateSchemas.ts └── tsconfig.json /.editorconfig: -------------------------------------------------------------------------------- 1 | # top-most EditorConfig file 2 | root = true 3 | 4 | # Unix-style newlines with a newline ending every file 5 | [*.{js,ts}] 6 | indent_style = space 7 | indent_size = 4 -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Ensure text files have LF line endings 2 | * text eol=lf 3 | 4 | # Denote all files that are truly binary and should never be modified. 5 | *.png binary 6 | *.jpg binary -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: [foxriver76, Apollon77, AlCalzone] 2 | patreon: Apollon77 3 | custom: ['https://paypal.me/foxriver76', 'https://paypal.me/dgriesel', 'https://paypal.me/Apollon77', 'https://paypal.me/ioBrokerGmbH'] 4 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: ioBroker Forum 4 | url: https://forum.iobroker.net/ 5 | about: Please ask and answer questions here. -------------------------------------------------------------------------------- /.github/actions/install-redis-linux/action.yml: -------------------------------------------------------------------------------- 1 | name: 'Install Redis Linux' 2 | description: 'Install Redis and Redis Sentinel on Linux' 3 | author: 'foxriver76' 4 | 5 | runs: 6 | using: 'composite' 7 | steps: 8 | - name: Install Redis and Redis Sentinel 9 | shell: bash 10 | run: | 11 | curl -fsSL https://packages.redis.io/gpg | sudo gpg --dearmor -o /usr/share/keyrings/redis-archive-keyring.gpg 12 | echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/redis.list 13 | sudo apt-get update -q 14 | sudo apt-get install -y redis-server redis-sentinel -------------------------------------------------------------------------------- /.github/auto-merge.yml: -------------------------------------------------------------------------------- 1 | # Configure here which dependency updates should be merged automatically. 2 | # The recommended configuration is the following: 3 | - match: 4 | # Only merge patches for production dependencies 5 | dependency_type: production 6 | update_type: "semver:patch" 7 | - match: 8 | # Except for security fixes, here we allow minor patches 9 | dependency_type: production 10 | update_type: "security:minor" 11 | - match: 12 | # and development dependencies can have a minor update, too 13 | dependency_type: development 14 | update_type: "semver:minor" 15 | 16 | # The syntax is based on the legacy dependabot v1 automerged_updates syntax, see: 17 | # https://dependabot.com/docs/config-file/#automerged_updates -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | # Maintain dependencies for GitHub Actions 4 | - package-ecosystem: github-actions 5 | directory: "/" 6 | schedule: 7 | interval: monthly 8 | time: "04:00" 9 | timezone: Europe/Berlin 10 | 11 | - package-ecosystem: npm 12 | directory: "/" 13 | schedule: 14 | interval: monthly 15 | time: "04:00" 16 | timezone: Europe/Berlin 17 | open-pull-requests-limit: 5 18 | versioning-strategy: increase 19 | -------------------------------------------------------------------------------- /.github/workflows/auto-approve-nightly.yml: -------------------------------------------------------------------------------- 1 | name: Auto approve 2 | 3 | on: 4 | pull_request: 5 | types: [labeled] 6 | 7 | jobs: 8 | auto-approve: 9 | if: | 10 | github.actor == 'foxriver76' && 11 | github.event.label.name == 'automated pr' 12 | 13 | runs-on: ubuntu-latest 14 | steps: 15 | - uses: hmarr/auto-approve-action@v4 16 | with: 17 | github-token: ${{ secrets.GITHUB_TOKEN }} -------------------------------------------------------------------------------- /.github/workflows/codeql.yml: -------------------------------------------------------------------------------- 1 | name: "CodeQL" 2 | 3 | on: 4 | push: 5 | branches: [ "master" ] 6 | pull_request: 7 | branches: [ "master" ] 8 | schedule: 9 | - cron: "57 11 * * 1" 10 | 11 | jobs: 12 | analyze: 13 | name: Analyze 14 | runs-on: ubuntu-latest 15 | permissions: 16 | actions: read 17 | contents: read 18 | security-events: write 19 | 20 | strategy: 21 | fail-fast: false 22 | matrix: 23 | language: [ javascript ] 24 | 25 | steps: 26 | - name: Checkout 27 | uses: actions/checkout@v4 28 | 29 | - name: Initialize CodeQL 30 | uses: github/codeql-action/init@v3 31 | with: 32 | languages: ${{ matrix.language }} 33 | queries: +security-and-quality 34 | 35 | - name: Autobuild 36 | uses: github/codeql-action/autobuild@v3 37 | 38 | - name: Perform CodeQL Analysis 39 | uses: github/codeql-action/analyze@v3 40 | with: 41 | category: "/language:${{ matrix.language }}" 42 | -------------------------------------------------------------------------------- /.github/workflows/dependabot-automerge.yml: -------------------------------------------------------------------------------- 1 | # Automatically merge Dependabot PRs when version comparison is within the range 2 | # that is configured in .github/auto-merge.yml 3 | 4 | name: Auto-Merge Dependabot PRs 5 | 6 | on: 7 | pull_request_target: 8 | 9 | jobs: 10 | auto-merge: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - name: Checkout code 14 | uses: actions/checkout@v4 15 | 16 | - name: Check if PR should be auto-merged 17 | uses: ahmadnassri/action-dependabot-auto-merge@v2 18 | with: 19 | # This must be a personal access token with push access 20 | github-token: ${{ secrets.AUTO_MERGE_TOKEN }} 21 | # By default, squash and merge, so Github chooses nice commit messages 22 | command: squash and merge -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | node_modules 3 | **/conf/iobroker.json 4 | **/log/iobroker.log 5 | **/lib/ioBroker.pid 6 | **/adapter/email 7 | **/adapter/sonos 8 | **/adapter/admin 9 | **/data 10 | /npm-debug.log 11 | **/tmp 12 | **/log 13 | **/pids.txt 14 | **/backups 15 | **/cache 16 | **/test/coverage 17 | **/test/report 18 | **/conf/sources-dist.json 19 | /.npmrc 20 | /*.pid 21 | **/test/tmp 22 | **/test/redis-sentinel/log 23 | **/test/redis-sentinel/*.config 24 | /lib/.greenlockrc 25 | /.greenlockrc 26 | /.dev-server 27 | ioB 28 | ioBroker 29 | *.tsbuildinfo 30 | /packages/controller/ioBroker.pid 31 | /packages/controller/iob-vendor.json 32 | build 33 | lerna-debug.log 34 | .nx 35 | -------------------------------------------------------------------------------- /.mocharc.json: -------------------------------------------------------------------------------- 1 | { 2 | "loader": "ts-node/esm" 3 | } 4 | -------------------------------------------------------------------------------- /.nvmrc: -------------------------------------------------------------------------------- 1 | 22 -------------------------------------------------------------------------------- /.prettierignore: -------------------------------------------------------------------------------- 1 | # Ignore artifacts: 2 | build 3 | **/node_modules/**/* 4 | packages/controller/data/**/* 5 | packages/controller/doc/**/* 6 | data 7 | -------------------------------------------------------------------------------- /.releaseconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "plugins": ["iobroker", "lerna", "manual-review", "license"], 3 | "license": [ 4 | "{LICENSE,README}{,.md}", 5 | "packages/*/{LICENSE,README}{,.md}" 6 | ], 7 | "ioPackage": "packages/controller", 8 | "ioPackageNoPrerelease": true, 9 | "publishAll": true 10 | } 11 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "typescript.tsdk": "node_modules/typescript/lib" 3 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2014-2024 bluefox, 4 | Copyright (c) 2014 hobbyquaker 5 | 6 | Permission is hereby granted, free of charge, to any person obtaining a copy 7 | of this software and associated documentation files (the "Software"), to deal 8 | in the Software without restriction, including without limitation the rights 9 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 | copies of the Software, and to permit persons to whom the Software is 11 | furnished to do so, subject to the following conditions: 12 | 13 | The above copyright notice and this permission notice shall be included in 14 | all copies or substantial portions of the Software. 15 | 16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 22 | THE SOFTWARE. 23 | -------------------------------------------------------------------------------- /eslint.config.mjs: -------------------------------------------------------------------------------- 1 | import config, { esmConfig } from '@iobroker/eslint-config'; 2 | 3 | export default [ 4 | { 5 | ignores: ['**/build/*'], 6 | }, 7 | ...config, 8 | ...esmConfig, 9 | { 10 | files: ['**/*.test-d.ts'], 11 | rules: { 12 | '@typescript-eslint/no-unused-vars': 'off', 13 | '@typescript-eslint/no-base-to-string': 'off', 14 | }, 15 | }, 16 | ]; 17 | -------------------------------------------------------------------------------- /iobroker.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ioBroker/ioBroker.js-controller/6ade4045339082a9408e17e0871ad26dc41206ca/iobroker.png -------------------------------------------------------------------------------- /lerna.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "7.0.8-alpha.2-20250522-ec9b0b016", 3 | "command": { 4 | "run": { 5 | "stream": true 6 | }, 7 | "version": { 8 | "allowBranch": ["master", "*.x"], 9 | "ignoreChanges": ["*.md"], 10 | "exact": true 11 | } 12 | }, 13 | "$schema": "node_modules/lerna/schemas/lerna-schema.json" 14 | } 15 | -------------------------------------------------------------------------------- /nx.json: -------------------------------------------------------------------------------- 1 | { 2 | "tasksRunnerOptions": { 3 | "default": { 4 | "runner": "nx/tasks-runners/default", 5 | "options": { 6 | "cacheableOperations": [], 7 | "parallel": 5 8 | } 9 | } 10 | }, 11 | "targetDefaults": { 12 | "build": { 13 | "dependsOn": [ 14 | "^build", 15 | "prebuild" 16 | ] 17 | }, 18 | "test": { 19 | "dependsOn": [ 20 | "build" 21 | ] 22 | } 23 | }, 24 | "$schema": "./node_modules/nx/schemas/nx-schema.json", 25 | "namedInputs": { 26 | "default": [ 27 | "{projectRoot}/**/*", 28 | "sharedGlobals" 29 | ], 30 | "sharedGlobals": [], 31 | "production": [ 32 | "default" 33 | ] 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /packages/adapter/README.md: -------------------------------------------------------------------------------- 1 | # Adapter class for ioBroker 2 | The Library contains the Adapter class of ioBroker. 3 | 4 | ## License 5 | MIT 6 | Copyright 2018-2024 bluefox 7 | -------------------------------------------------------------------------------- /packages/adapter/src/cert/cloudCert.crt: -------------------------------------------------------------------------------- 1 | -----BEGIN PUBLIC KEY----- 2 | MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAp1C0AJ+H6KeRo77undcx 3 | kyKDn3edWDaTNrxvg4DhlGgCEBAcStoROu+6TKMw5bc/V+U4s7vqfz9vxh4GXtUk 4 | RwPsx2ggrhp08bUYeO9zA9EMFICD6Klva6FALqCLpwv4e8g1CzeKQqhxzAe7v/Ey 5 | dMW4foMyugGHGEO6ZCbHyPMdrg0A4NmpSV/TsWduBbjkq03D63ovAzM+u2lAHHrt 6 | 84QShY1ZZoRCHD2F7bRQW906wiVZNfQYKSeTkfc9Ctatuz8JMIq57dlyAF/R6+jC 7 | UodEZvqO9ZTDRGbX2MWDdedRMAt8hPQxjxugiUheMCCrTbdZ5bxeXqyaTLYuzNyV 8 | bwIDAQAB 9 | -----END PUBLIC KEY----- -------------------------------------------------------------------------------- /packages/adapter/src/index.ts: -------------------------------------------------------------------------------- 1 | /// 2 | export { Adapter, AdapterClass } from '@/lib/adapter/adapter.js'; 3 | export { Validator } from '@/lib/adapter/validator.js'; 4 | export * from '@/lib/_Types.js'; 5 | -------------------------------------------------------------------------------- /packages/adapter/tsconfig.build.json: -------------------------------------------------------------------------------- 1 | // Specialized tsconfig to only compile .ts-files in the src dir 2 | { 3 | "extends": "./tsconfig.json", 4 | "compilerOptions": { 5 | "allowJs": false, 6 | "checkJs": false, 7 | "noEmit": false 8 | }, 9 | "references": [ 10 | { 11 | "path": "../db-objects-file/tsconfig.build.json" 12 | }, 13 | { 14 | "path": "../db-objects-jsonl/tsconfig.build.json" 15 | }, 16 | { 17 | "path": "../db-objects-redis/tsconfig.build.json" 18 | }, 19 | { 20 | "path": "../db-states-file/tsconfig.build.json" 21 | }, 22 | { 23 | "path": "../db-states-jsonl/tsconfig.build.json" 24 | }, 25 | { 26 | "path": "../db-states-redis/tsconfig.build.json" 27 | }, 28 | { 29 | "path": "../common/tsconfig.build.json" 30 | }, 31 | { 32 | "path": "../common-db/tsconfig.build.json" 33 | }, 34 | ], 35 | "include": [ 36 | "src/**/*.ts", 37 | "src/**/*.js" // currently, we have js too 38 | ], 39 | "exclude": [ 40 | "src/**/*.test.ts", 41 | "build/**", 42 | "node_modules/**" 43 | ] 44 | } -------------------------------------------------------------------------------- /packages/adapter/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json", 3 | "compilerOptions": { 4 | "outDir": "build/esm", 5 | "rootDir": "src", 6 | "module": "NodeNext", 7 | "paths": { 8 | "@/*": [ 9 | "./src/*" 10 | ] 11 | } 12 | }, 13 | "references": [ 14 | { 15 | "path": "../db-objects-file/tsconfig.json" 16 | }, 17 | { 18 | "path": "../db-objects-jsonl/tsconfig.json" 19 | }, 20 | { 21 | "path": "../db-objects-redis/tsconfig.json" 22 | }, 23 | { 24 | "path": "../db-states-file/tsconfig.json" 25 | }, 26 | { 27 | "path": "../db-states-jsonl/tsconfig.json" 28 | }, 29 | { 30 | "path": "../db-states-redis/tsconfig.json" 31 | }, 32 | { 33 | "path": "../common/tsconfig.json" 34 | }, 35 | { 36 | "path": "../common-db/tsconfig.json" 37 | }, 38 | ], 39 | "include": [ 40 | "src/**/*.ts" 41 | ], 42 | "exclude": [ 43 | "src/**/*.test.ts", 44 | "build/**", 45 | "node_modules/**" 46 | ] 47 | } -------------------------------------------------------------------------------- /packages/cli/README.md: -------------------------------------------------------------------------------- 1 | # CLI class for ioBroker 2 | The Library contains the cli classes of ioBroker. 3 | 4 | ## License 5 | MIT 6 | Copyright 2018-2024 bluefox 7 | -------------------------------------------------------------------------------- /packages/cli/src/index.ts: -------------------------------------------------------------------------------- 1 | /// 2 | export { execute } from '@/lib/setup.js'; 3 | export { dbConnectAsync } from '@/lib/setup/dbConnection.js'; 4 | export { Vendor } from '@/lib/setup/setupVendor.js'; 5 | export { Upload } from '@/lib/setup/setupUpload.js'; 6 | export { Upgrade } from '@/lib/setup/setupUpgrade.js'; 7 | export { BackupRestore } from '@/lib/setup/setupBackup.js'; 8 | export { PacketManager, type UpgradePacket } from '@/lib/setup/setupPacketManager.js'; 9 | export * from '@/lib/_Types.js'; 10 | -------------------------------------------------------------------------------- /packages/cli/src/lib/setup/customError.ts: -------------------------------------------------------------------------------- 1 | import type { EXIT_CODES } from '@iobroker/js-controller-common'; 2 | 3 | export interface IoBrokerErrorOptions { 4 | /** The error message */ 5 | message: string; 6 | /** An ioBroker error code */ 7 | code: EXIT_CODES; 8 | } 9 | 10 | /** 11 | * A custom ioBroker CLI error to propagate the exit code down 12 | */ 13 | export class IoBrokerError extends Error { 14 | readonly code: EXIT_CODES; 15 | constructor(options: IoBrokerErrorOptions) { 16 | super(options.message); 17 | 18 | this.name = this.constructor.name; 19 | 20 | Error.captureStackTrace(this, this.constructor); 21 | 22 | // you may also assign additional properties to your error 23 | this.code = options.code; 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /packages/cli/tsconfig.build.json: -------------------------------------------------------------------------------- 1 | // Specialized tsconfig to only compile .ts-files in the src dir 2 | { 3 | "extends": "./tsconfig.json", 4 | "compilerOptions": { 5 | "allowJs": true, 6 | "checkJs": false, 7 | "noEmit": false 8 | }, 9 | "references": [ 10 | { 11 | "path": "../common/tsconfig.build.json" 12 | }, 13 | { 14 | "path": "../common-db/tsconfig.build.json" 15 | }, 16 | ], 17 | "include": [ 18 | "src/**/*.ts", 19 | "src/**/*.js" // currently, we have js too 20 | ], 21 | "exclude": [ 22 | "src/**/*.test.ts", 23 | "build/**", 24 | "node_modules/**" 25 | ] 26 | } -------------------------------------------------------------------------------- /packages/cli/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json", 3 | "compilerOptions": { 4 | "outDir": "build/esm", 5 | "rootDir": "src", 6 | "module": "NodeNext", 7 | "paths": { 8 | "@/*": [ 9 | "./src/*" 10 | ] 11 | } 12 | }, 13 | "references": [ 14 | { 15 | "path": "../common/tsconfig.json" 16 | }, 17 | { 18 | "path": "../common-db/tsconfig.json" 19 | } 20 | ], 21 | "include": [ 22 | "src/**/*.ts", 23 | "src/**/*.js" 24 | ], 25 | "exclude": [ 26 | "build/**", 27 | "node_modules/**" 28 | ] 29 | } -------------------------------------------------------------------------------- /packages/common-db/README.md: -------------------------------------------------------------------------------- 1 | # Common DB class for ioBroker 2 | The Library contains the common utils for the ioBroker controller which can be used by db classes too, as they do not rely on the db (circular dependencies). 3 | 4 | ## License 5 | MIT 6 | Copyright 2018-2024 bluefox 7 | -------------------------------------------------------------------------------- /packages/common-db/src/index.ts: -------------------------------------------------------------------------------- 1 | /// 2 | export * as tools from '@/lib/common/tools.js'; 3 | export { EXIT_CODES } from '@/lib/common/exitCodes.js'; 4 | export { password } from '@/lib/common/password.js'; 5 | export { logger } from '@/lib/common/logger.js'; 6 | export { defaultRedisInterview } from '@/lib/common/interview.js'; 7 | export { createAdapterStore as session } from '@/lib/common/session.js'; 8 | export * as constants from '@/lib/common/constants.js'; 9 | -------------------------------------------------------------------------------- /packages/common-db/src/lib/common/constants.ts: -------------------------------------------------------------------------------- 1 | /** Prefix for system internal adapter and instance ids */ 2 | export const SYSTEM_ADAPTER_PREFIX = 'system.adapter.'; 3 | /** Prefix for host object ids */ 4 | export const SYSTEM_HOST_PREFIX = 'system.host.'; 5 | /** The system repositories id */ 6 | export const SYSTEM_REPOSITORIES_ID = 'system.repositories'; 7 | /** The system config id */ 8 | export const SYSTEM_CONFIG_ID = 'system.config'; 9 | /** Unicode symbol to be appended on endkey of getObjectView */ 10 | export const HIGHEST_UNICODE_SYMBOL = '\u9999'; 11 | -------------------------------------------------------------------------------- /packages/common-db/src/lib/types.d.ts: -------------------------------------------------------------------------------- 1 | export {}; 2 | 3 | declare global { 4 | namespace NodeJS { 5 | interface ProcessEnv { 6 | /** The build time of the Docker image, only available in the official Docker image */ 7 | BUILD: string; 8 | /** Allows overriding the host name via env variable for test purposes */ 9 | IOB_HOSTNAME?: string; 10 | } 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /packages/common-db/tsconfig.build.json: -------------------------------------------------------------------------------- 1 | // Specialized tsconfig to only compile .ts-files in the src dir 2 | { 3 | "extends": "./tsconfig.json", 4 | "compilerOptions": { 5 | "allowJs": false, 6 | "checkJs": false, 7 | "noEmit": false, 8 | "outDir": "build/esm" 9 | }, 10 | "include": [ 11 | "src/**/*.ts", 12 | "src/**/*.d.ts" 13 | ], 14 | "exclude": [ 15 | "src/**/*.test.ts", 16 | "build/**", 17 | "node_modules/**" 18 | ] 19 | } 20 | -------------------------------------------------------------------------------- /packages/common-db/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json", 3 | "compilerOptions": { 4 | "outDir": "build/esm", 5 | "rootDir": "src", 6 | "module": "NodeNext", 7 | "paths": { 8 | "@/*": [ 9 | "./src/*" 10 | ] 11 | } 12 | }, 13 | "include": [ 14 | "src/**/*.ts", 15 | "src/**/*.d.ts" 16 | ], 17 | "exclude": [ 18 | "build/**", 19 | "node_modules/**" 20 | ] 21 | } 22 | -------------------------------------------------------------------------------- /packages/common/README.md: -------------------------------------------------------------------------------- 1 | # Common class for ioBroker 2 | The Library contains the common utils of ioBroker which use the DB directly and thus cannot be required by the DB itself (cirular dependencies). 3 | It makes sense to place methods here too, which require typings from the database if they are surely not used by the database. 4 | 5 | ## License 6 | MIT 7 | Copyright 2018-2024 bluefox 8 | -------------------------------------------------------------------------------- /packages/common/src/index.ts: -------------------------------------------------------------------------------- 1 | /// 2 | export { 3 | getStatesConstructor, 4 | statesDbHasServer, 5 | isLocalStatesDbServer, 6 | performStatesInterview, 7 | } from '@/lib/common/states.js'; 8 | export { 9 | getObjectsConstructor, 10 | objectsDbHasServer, 11 | isLocalObjectsDbServer, 12 | performObjectsInterview, 13 | } from '@/lib/common/objects.js'; 14 | export { NotificationHandler } from '@/lib/common/notificationHandler.js'; 15 | export * as zipFiles from '@/lib/common/zipFiles.js'; 16 | export * from '@/lib/common/tools.js'; 17 | export * from '@iobroker/js-controller-common-db'; 18 | 19 | /** Shim until all adapters are using adapter-core 3.1.4 or higher */ 20 | export const letsencrypt = true; 21 | -------------------------------------------------------------------------------- /packages/common/tsconfig.build.json: -------------------------------------------------------------------------------- 1 | // Specialized tsconfig to only compile .ts-files in the src dir 2 | { 3 | "extends": "./tsconfig.json", 4 | "compilerOptions": { 5 | "allowJs": false, 6 | "checkJs": false, 7 | "noEmit": false 8 | }, 9 | "references": [ 10 | { 11 | "path": "../db-objects-file/tsconfig.build.json" 12 | }, 13 | { 14 | "path": "../db-objects-jsonl/tsconfig.build.json" 15 | }, 16 | { 17 | "path": "../db-objects-redis/tsconfig.build.json" 18 | }, 19 | { 20 | "path": "../db-states-file/tsconfig.build.json" 21 | }, 22 | { 23 | "path": "../db-states-jsonl/tsconfig.build.json" 24 | }, 25 | { 26 | "path": "../db-states-redis/tsconfig.build.json" 27 | }, 28 | { 29 | "path": "../common-db/tsconfig.build.json" 30 | }, 31 | ], 32 | "include": [ 33 | "src/**/*.ts" 34 | ], 35 | "exclude": [ 36 | "src/**/*.test.ts", 37 | "build/**", 38 | "node_modules/**" 39 | ] 40 | } -------------------------------------------------------------------------------- /packages/common/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json", 3 | "compilerOptions": { 4 | // we migrated this package to have stricter checks 5 | "noUncheckedIndexedAccess": true, 6 | "outDir": "build/esm", 7 | "module": "NodeNext", 8 | "rootDir": "src", 9 | "noEmit": false, 10 | "paths": { 11 | "@/*": [ 12 | "./src/*" 13 | ] 14 | } 15 | }, 16 | "references": [ 17 | { 18 | "path": "../db-objects-file/tsconfig.json" 19 | }, 20 | { 21 | "path": "../db-objects-jsonl/tsconfig.json" 22 | }, 23 | { 24 | "path": "../db-objects-redis/tsconfig.json" 25 | }, 26 | { 27 | "path": "../db-states-file/tsconfig.json" 28 | }, 29 | { 30 | "path": "../db-states-jsonl/tsconfig.json" 31 | }, 32 | { 33 | "path": "../db-states-redis/tsconfig.json" 34 | }, 35 | { 36 | "path": "../common-db/tsconfig.json" 37 | } 38 | ], 39 | "include": [ 40 | "src/**/*.ts" 41 | ], 42 | "exclude": [ 43 | "build/**", 44 | "node_modules/**" 45 | ] 46 | } -------------------------------------------------------------------------------- /packages/controller/README.md: -------------------------------------------------------------------------------- 1 | # Controller class for ioBroker 2 | The Library contains the Controller class of ioBroker and is the main part, which is executed. 3 | 4 | ## License 5 | MIT 6 | Copyright 2018-2024 bluefox 7 | -------------------------------------------------------------------------------- /packages/controller/controller.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Redirect for older installations 3 | * 4 | * Copyright 2018-2024 bluefox , 5 | * MIT License 6 | * 7 | */ 8 | 9 | import('./build/esm/main.js').then(res => res.init()); 10 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/ACLObject.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ACLObject 6 | 7 | # Interface: ACLObject 8 | 9 | ## Properties 10 | 11 | ### file 12 | 13 | > **file**: `number` 14 | 15 | #### Defined in 16 | 17 | db-objects-redis/build/esm/lib/objects/objectsUtils.d.ts:24 18 | 19 | *** 20 | 21 | ### object 22 | 23 | > **object**: `number` 24 | 25 | #### Defined in 26 | 27 | db-objects-redis/build/esm/lib/objects/objectsUtils.d.ts:22 28 | 29 | *** 30 | 31 | ### owner 32 | 33 | > **owner**: `string` 34 | 35 | #### Defined in 36 | 37 | db-objects-redis/build/esm/lib/objects/objectsUtils.d.ts:20 38 | 39 | *** 40 | 41 | ### ownerGroup 42 | 43 | > **ownerGroup**: `string` 44 | 45 | #### Defined in 46 | 47 | db-objects-redis/build/esm/lib/objects/objectsUtils.d.ts:21 48 | 49 | *** 50 | 51 | ### state 52 | 53 | > **state**: `number` 54 | 55 | #### Defined in 56 | 57 | db-objects-redis/build/esm/lib/objects/objectsUtils.d.ts:23 58 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/AdapterConfig.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / AdapterConfig 6 | 7 | # Interface: AdapterConfig 8 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/AdapterOptionsConfig.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / AdapterOptionsConfig 6 | 7 | # Interface: AdapterOptionsConfig 8 | 9 | ## Properties 10 | 11 | ### log 12 | 13 | > **log**: `object` 14 | 15 | #### level 16 | 17 | > **level**: [`LogLevel`](../type-aliases/LogLevel.md) 18 | 19 | #### Defined in 20 | 21 | [adapter/src/lib/\_Types.ts:199](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L199) 22 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/AliasDetails.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / AliasDetails 6 | 7 | # Interface: AliasDetails 8 | 9 | ## Properties 10 | 11 | ### source? 12 | 13 | > `optional` **source**: [`AliasDetailsSource`](AliasDetailsSource.md) 14 | 15 | #### Defined in 16 | 17 | [adapter/src/lib/\_Types.ts:211](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L211) 18 | 19 | *** 20 | 21 | ### targets 22 | 23 | > **targets**: [`AliasTargetEntry`](AliasTargetEntry.md)[] 24 | 25 | #### Defined in 26 | 27 | [adapter/src/lib/\_Types.ts:212](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L212) 28 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/BackupOptions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / BackupOptions 6 | 7 | # Interface: BackupOptions 8 | 9 | ## Properties 10 | 11 | ### disabled 12 | 13 | > **disabled**: `boolean` 14 | 15 | deactivates backup if true 16 | 17 | #### Defined in 18 | 19 | db-base/build/esm/lib/inMemFileDB.d.ts:30 20 | 21 | *** 22 | 23 | ### files 24 | 25 | > **files**: `number` 26 | 27 | minimum number of files 28 | 29 | #### Defined in 30 | 31 | db-base/build/esm/lib/inMemFileDB.d.ts:32 32 | 33 | *** 34 | 35 | ### hours 36 | 37 | > **hours**: `number` 38 | 39 | #### Defined in 40 | 41 | db-base/build/esm/lib/inMemFileDB.d.ts:33 42 | 43 | *** 44 | 45 | ### path 46 | 47 | > **path**: `string` 48 | 49 | #### Defined in 50 | 51 | db-base/build/esm/lib/inMemFileDB.d.ts:36 52 | 53 | *** 54 | 55 | ### period 56 | 57 | > **period**: `number` 58 | 59 | minutes 60 | 61 | #### Defined in 62 | 63 | db-base/build/esm/lib/inMemFileDB.d.ts:35 64 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/Certificates.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Certificates 6 | 7 | # Interface: Certificates 8 | 9 | ## Properties 10 | 11 | ### ca? 12 | 13 | > `optional` **ca**: `string` 14 | 15 | chained CA certificates 16 | 17 | #### Defined in 18 | 19 | [types-dev/index.d.ts:246](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L246) 20 | 21 | *** 22 | 23 | ### cert 24 | 25 | > **cert**: `string` 26 | 27 | public certificate 28 | 29 | #### Defined in 30 | 31 | [types-dev/index.d.ts:244](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L244) 32 | 33 | *** 34 | 35 | ### key 36 | 37 | > **key**: `string` 38 | 39 | private key file 40 | 41 | #### Defined in 42 | 43 | [types-dev/index.d.ts:242](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L242) 44 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/CheckStatesResult.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / CheckStatesResult 6 | 7 | # Interface: CheckStatesResult 8 | 9 | ## Properties 10 | 11 | ### ids 12 | 13 | > **ids**: `string`[] 14 | 15 | #### Defined in 16 | 17 | [adapter/src/lib/\_Types.ts:234](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L234) 18 | 19 | *** 20 | 21 | ### objs 22 | 23 | > **objs**: [`StateObject`](StateObject.md)[] 24 | 25 | #### Defined in 26 | 27 | [adapter/src/lib/\_Types.ts:233](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L233) 28 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/DbStatus.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / DbStatus 6 | 7 | # Interface: DbStatus 8 | 9 | ## Properties 10 | 11 | ### server 12 | 13 | > **server**: `boolean` 14 | 15 | #### Defined in 16 | 17 | db-base/build/esm/lib/inMemFileDB.d.ts:26 18 | 19 | *** 20 | 21 | ### type 22 | 23 | > **type**: `string` 24 | 25 | #### Defined in 26 | 27 | db-base/build/esm/lib/inMemFileDB.d.ts:25 28 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/DelObjectOptions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / DelObjectOptions 6 | 7 | # Interface: DelObjectOptions 8 | 9 | ## Indexable 10 | 11 | \[`other`: `string`\]: `unknown` 12 | 13 | ## Properties 14 | 15 | ### recursive? 16 | 17 | > `optional` **recursive**: `boolean` 18 | 19 | Whether all child objects should be deleted as well 20 | 21 | #### Defined in 22 | 23 | [types-dev/index.d.ts:353](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L353) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/ExtendObjectOptions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ExtendObjectOptions 6 | 7 | # Interface: ExtendObjectOptions 8 | 9 | ## Indexable 10 | 11 | \[`other`: `string`\]: `unknown` 12 | 13 | ## Properties 14 | 15 | ### preserve? 16 | 17 | > `optional` **preserve**: [`ExtendObjectOptionsPreserve`](ExtendObjectOptionsPreserve.md) 18 | 19 | Which properties of the original object should be preserved 20 | 21 | #### Defined in 22 | 23 | [types-dev/index.d.ts:364](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L364) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/ExtendObjectOptionsPreserve.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ExtendObjectOptionsPreserve 6 | 7 | # Interface: ExtendObjectOptionsPreserve 8 | 9 | ## Indexable 10 | 11 | \[`prop`: `string`\]: [`ExtendObjectOptionsPreserve`](ExtendObjectOptionsPreserve.md) \| `boolean` \| `string`[] 12 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/GetObjectViewItem.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetObjectViewItem 6 | 7 | # Interface: GetObjectViewItem\ 8 | 9 | ## Extended by 10 | 11 | - [`GetObjectListItem`](GetObjectListItem.md) 12 | 13 | ## Type Parameters 14 | 15 | • **T** *extends* [`AnyObject`](../type-aliases/AnyObject.md) 16 | 17 | ## Properties 18 | 19 | ### id 20 | 21 | > **id**: `T`\[`"_id"`\] 22 | 23 | The ID of this object 24 | 25 | #### Defined in 26 | 27 | [types-dev/index.d.ts:545](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L545) 28 | 29 | *** 30 | 31 | ### value 32 | 33 | > **value**: `T` 34 | 35 | A copy of the object from the DB 36 | 37 | #### Defined in 38 | 39 | [types-dev/index.d.ts:547](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L547) 40 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/GetUserGroupsOptions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetUserGroupsOptions 6 | 7 | # Interface: GetUserGroupsOptions 8 | 9 | ## Indexable 10 | 11 | \[`other`: `string`\]: `any` 12 | 13 | ## Properties 14 | 15 | ### user 16 | 17 | > **user**: \`system.user.$\{string\}\` 18 | 19 | #### Defined in 20 | 21 | [adapter/src/lib/\_Types.ts:243](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L243) 22 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/HeartbeatTimer.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / HeartbeatTimer 6 | 7 | # Interface: HeartbeatTimer 8 | 9 | ## Properties 10 | 11 | ### heartbeat 12 | 13 | > **heartbeat**: `number` 14 | 15 | The heartbeat interval 16 | 17 | #### Defined in 18 | 19 | [adapter/src/lib/adapter/userInterfaceMessagingController.ts:14](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/adapter/userInterfaceMessagingController.ts#L14) 20 | 21 | *** 22 | 23 | ### timer 24 | 25 | > **timer**: `Timeout` 26 | 27 | The actual timer 28 | 29 | #### Defined in 30 | 31 | [adapter/src/lib/adapter/userInterfaceMessagingController.ts:12](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/adapter/userInterfaceMessagingController.ts#L12) 32 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/IdObject.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / IdObject 6 | 7 | # Interface: IdObject 8 | 9 | ## Properties 10 | 11 | ### channel? 12 | 13 | > `optional` **channel**: `string` 14 | 15 | #### Defined in 16 | 17 | [types-dev/index.d.ts:93](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L93) 18 | 19 | *** 20 | 21 | ### device? 22 | 23 | > `optional` **device**: `string` 24 | 25 | #### Defined in 26 | 27 | [types-dev/index.d.ts:92](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L92) 28 | 29 | *** 30 | 31 | ### state? 32 | 33 | > `optional` **state**: `string` 34 | 35 | #### Defined in 36 | 37 | [types-dev/index.d.ts:94](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L94) 38 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/InstallNodeModuleOptions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / InstallNodeModuleOptions 6 | 7 | # Interface: InstallNodeModuleOptions 8 | 9 | ## Extended by 10 | 11 | - [`InternalInstallNodeModuleOptions`](InternalInstallNodeModuleOptions.md) 12 | 13 | ## Properties 14 | 15 | ### version 16 | 17 | > **version**: `string` 18 | 19 | Version of node module 20 | 21 | #### Defined in 22 | 23 | [adapter/src/lib/\_Types.ts:605](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L605) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/InternalDeleteDeviceOptions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / InternalDeleteDeviceOptions 6 | 7 | # Interface: InternalDeleteDeviceOptions 8 | 9 | ## Properties 10 | 11 | ### callback? 12 | 13 | > `optional` **callback**: [`ErrorCallback`](../type-aliases/ErrorCallback.md) 14 | 15 | #### Defined in 16 | 17 | [adapter/src/lib/\_Types.ts:518](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L518) 18 | 19 | *** 20 | 21 | ### deviceName 22 | 23 | > **deviceName**: `string` 24 | 25 | #### Defined in 26 | 27 | [adapter/src/lib/\_Types.ts:517](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L517) 28 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/InternalDestroySessionOptions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / InternalDestroySessionOptions 6 | 7 | # Interface: InternalDestroySessionOptions 8 | 9 | ## Properties 10 | 11 | ### callback? 12 | 13 | > `optional` **callback**: [`ErrorCallback`](../type-aliases/ErrorCallback.md) 14 | 15 | #### Defined in 16 | 17 | [adapter/src/lib/\_Types.ts:265](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L265) 18 | 19 | *** 20 | 21 | ### id 22 | 23 | > **id**: `string` 24 | 25 | #### Defined in 26 | 27 | [adapter/src/lib/\_Types.ts:264](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L264) 28 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/InternalFormatDateOptions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / InternalFormatDateOptions 6 | 7 | # Interface: InternalFormatDateOptions 8 | 9 | ## Properties 10 | 11 | ### \_format? 12 | 13 | > `optional` **\_format**: `string` 14 | 15 | #### Defined in 16 | 17 | [adapter/src/lib/\_Types.ts:207](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L207) 18 | 19 | *** 20 | 21 | ### dateObj 22 | 23 | > **dateObj**: `string` \| `number` \| `Date` 24 | 25 | #### Defined in 26 | 27 | [adapter/src/lib/\_Types.ts:205](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L205) 28 | 29 | *** 30 | 31 | ### isDuration 32 | 33 | > **isDuration**: `boolean` 34 | 35 | #### Defined in 36 | 37 | [adapter/src/lib/\_Types.ts:206](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L206) 38 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/InternalGetAdapterObjectsOptions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / InternalGetAdapterObjectsOptions 6 | 7 | # Interface: InternalGetAdapterObjectsOptions 8 | 9 | ## Properties 10 | 11 | ### callback()? 12 | 13 | > `optional` **callback**: (`objects`) => `void` 14 | 15 | #### Parameters 16 | 17 | • **objects**: `Record`\<`string`, [`AdapterScopedObject`](../type-aliases/AdapterScopedObject.md)\> 18 | 19 | #### Returns 20 | 21 | `void` 22 | 23 | #### Defined in 24 | 25 | [adapter/src/lib/\_Types.ts:399](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L399) 26 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/InternalGetDevicesOptions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / InternalGetDevicesOptions 6 | 7 | # Interface: InternalGetDevicesOptions 8 | 9 | ## Properties 10 | 11 | ### callback 12 | 13 | > **callback**: [`GetObjectsCallback3`](../type-aliases/GetObjectsCallback3.md)\<[`DeviceObject`](DeviceObject.md)\> 14 | 15 | #### Defined in 16 | 17 | [adapter/src/lib/\_Types.ts:545](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L545) 18 | 19 | *** 20 | 21 | ### options? 22 | 23 | > `optional` **options**: `null` \| `Record`\<`string`, `any`\> 24 | 25 | #### Defined in 26 | 27 | [adapter/src/lib/\_Types.ts:544](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L544) 28 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/InternalGetEncryptedConfigOptions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / InternalGetEncryptedConfigOptions 6 | 7 | # Interface: InternalGetEncryptedConfigOptions 8 | 9 | ## Properties 10 | 11 | ### attribute 12 | 13 | > **attribute**: `string` 14 | 15 | #### Defined in 16 | 17 | [adapter/src/lib/\_Types.ts:353](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L353) 18 | 19 | *** 20 | 21 | ### callback? 22 | 23 | > `optional` **callback**: [`GetEncryptedConfigCallback`](../type-aliases/GetEncryptedConfigCallback.md) 24 | 25 | #### Defined in 26 | 27 | [adapter/src/lib/\_Types.ts:354](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L354) 28 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/InternalGetSessionOptions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / InternalGetSessionOptions 6 | 7 | # Interface: InternalGetSessionOptions 8 | 9 | ## Properties 10 | 11 | ### callback 12 | 13 | > **callback**: [`GetSessionCallback`](../type-aliases/GetSessionCallback.md) 14 | 15 | #### Defined in 16 | 17 | [adapter/src/lib/\_Types.ts:260](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L260) 18 | 19 | *** 20 | 21 | ### id 22 | 23 | > **id**: `string` 24 | 25 | #### Defined in 26 | 27 | [adapter/src/lib/\_Types.ts:259](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L259) 28 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/InternalGetUserIDOptions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / InternalGetUserIDOptions 6 | 7 | # Interface: InternalGetUserIDOptions 8 | 9 | ## Properties 10 | 11 | ### username 12 | 13 | > **username**: `string` 14 | 15 | #### Defined in 16 | 17 | [adapter/src/lib/\_Types.ts:284](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L284) 18 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/InternalReportDeprecationOption.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / InternalReportDeprecationOption 6 | 7 | # Interface: InternalReportDeprecationOption 8 | 9 | ## Properties 10 | 11 | ### deprecationMessage 12 | 13 | > **deprecationMessage**: `string` 14 | 15 | The log line to report 16 | 17 | #### Defined in 18 | 19 | [adapter/src/lib/\_Types.ts:578](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L578) 20 | 21 | *** 22 | 23 | ### version? 24 | 25 | > `optional` **version**: `string` 26 | 27 | Version in which this warning will throw an error instead 28 | 29 | #### Defined in 30 | 31 | [adapter/src/lib/\_Types.ts:576](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L576) 32 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/InternalUpdateConfigOptions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / InternalUpdateConfigOptions 6 | 7 | # Interface: InternalUpdateConfigOptions 8 | 9 | ## Properties 10 | 11 | ### newConfig 12 | 13 | > **newConfig**: `Record`\<`string`, `any`\> 14 | 15 | #### Defined in 16 | 17 | [adapter/src/lib/\_Types.ts:347](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L347) 18 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/NotificationContextData.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / NotificationContextData 6 | 7 | # Interface: NotificationContextData 8 | 9 | Additional context for the notification which can be used by notification processing adapters 10 | 11 | ## Indexable 12 | 13 | \[`adapterNameOrAdapterType`: `string`\]: `unknown` 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/NotificationOptions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / NotificationOptions 6 | 7 | # Interface: NotificationOptions 8 | 9 | Options for the generated notification 10 | 11 | ## Properties 12 | 13 | ### contextData 14 | 15 | > **contextData**: [`NotificationContextData`](NotificationContextData.md) 16 | 17 | Additional context for the notification which can be used by notification processing adapters 18 | 19 | #### Defined in 20 | 21 | [adapter/src/lib/\_Types.ts:620](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L620) 22 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/NotificationScopes.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / NotificationScopes 6 | 7 | # Interface: NotificationScopes 8 | 9 | Predefined notification scopes and their categories 10 | 11 | ## Indexable 12 | 13 | \[`other`: `string`\]: `string` 14 | 15 | ## Properties 16 | 17 | ### system 18 | 19 | > **system**: `"memIssues"` \| `"fsIoErrors"` \| `"noDiskSpace"` \| `"accessErrors"` \| `"nonExistingFileErrors"` \| `"remoteHostErrors"` \| `"restartLoop"` \| `"fileToJsonl"` 20 | 21 | #### Defined in 22 | 23 | [types-dev/index.d.ts:371](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L371) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/Options.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Options 6 | 7 | # Interface: Options 8 | 9 | ## Indexable 10 | 11 | \[`other`: `string`\]: `unknown` 12 | 13 | ## Properties 14 | 15 | ### user? 16 | 17 | > `optional` **user**: `string` 18 | 19 | The user id for database operations 20 | 21 | #### Defined in 22 | 23 | db-objects-redis/build/esm/lib/objects/objectsInRedisClient.d.ts:40 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/RepositoryJson.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / RepositoryJson 6 | 7 | # Interface: RepositoryJson 8 | 9 | ## Indexable 10 | 11 | \[`adapter`: `string`\]: [`RepositoryJsonAdapterContent`](RepositoryJsonAdapterContent.md) \| [`RepoInfo`](RepoInfo.md) 12 | 13 | ## Properties 14 | 15 | ### \_repoInfo 16 | 17 | > **\_repoInfo**: [`RepoInfo`](RepoInfo.md) 18 | 19 | Information about the repository: creation time, name, is it stable 20 | 21 | #### Defined in 22 | 23 | [types-dev/objects.d.ts:1037](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L1037) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/RmResult.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / RmResult 6 | 7 | # Interface: RmResult 8 | 9 | Contains the return values of rm 10 | 11 | ## Properties 12 | 13 | ### file 14 | 15 | > **file**: `string` 16 | 17 | The name of the deleted file or directory 18 | 19 | #### Defined in 20 | 21 | [types-dev/index.d.ts:535](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L535) 22 | 23 | *** 24 | 25 | ### path 26 | 27 | > **path**: `string` 28 | 29 | The parent directory of the deleted file or directory 30 | 31 | #### Defined in 32 | 33 | [types-dev/index.d.ts:533](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L533) 34 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/SendToOptions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / SendToOptions 6 | 7 | # Interface: SendToOptions 8 | 9 | ## Properties 10 | 11 | ### timeout? 12 | 13 | > `optional` **timeout**: `number` 14 | 15 | Method throws or calls error cb, if callback not called in time, works for single targets only 16 | 17 | #### Defined in 18 | 19 | [adapter/src/lib/\_Types.ts:475](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L475) 20 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/SendToUserInterfaceClientOptions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / SendToUserInterfaceClientOptions 6 | 7 | # Interface: SendToUserInterfaceClientOptions 8 | 9 | ## Properties 10 | 11 | ### clientId? 12 | 13 | > `optional` **clientId**: `string` 14 | 15 | id of the UI client, if not given send to all active clients 16 | 17 | #### Defined in 18 | 19 | [adapter/src/lib/\_Types.ts:317](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L317) 20 | 21 | *** 22 | 23 | ### data 24 | 25 | > **data**: `unknown` 26 | 27 | data to send to the client 28 | 29 | #### Defined in 30 | 31 | [adapter/src/lib/\_Types.ts:319](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L319) 32 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/SetStateChangedResult.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / SetStateChangedResult 6 | 7 | # Interface: SetStateChangedResult 8 | 9 | ## Properties 10 | 11 | ### id 12 | 13 | > **id**: `string` 14 | 15 | #### Defined in 16 | 17 | [adapter/src/lib/\_Types.ts:239](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L239) 18 | 19 | *** 20 | 21 | ### notChanged 22 | 23 | > **notChanged**: `boolean` 24 | 25 | #### Defined in 26 | 27 | [adapter/src/lib/\_Types.ts:238](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L238) 28 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/StopParameters.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / StopParameters 6 | 7 | # Interface: StopParameters 8 | 9 | ## Extended by 10 | 11 | - [`InternalStopParameters`](InternalStopParameters.md) 12 | 13 | ## Properties 14 | 15 | ### exitCode? 16 | 17 | > `optional` **exitCode**: `number` 18 | 19 | Specify an optional exit code 20 | 21 | #### Defined in 22 | 23 | [adapter/src/lib/\_Types.ts:583](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L583) 24 | 25 | *** 26 | 27 | ### reason? 28 | 29 | > `optional` **reason**: `string` 30 | 31 | Specify an optional reason for stoppage 32 | 33 | #### Defined in 34 | 35 | [adapter/src/lib/\_Types.ts:585](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L585) 36 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/UserInterfaceSubscribeInfo.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / UserInterfaceSubscribeInfo 6 | 7 | # Interface: UserInterfaceSubscribeInfo 8 | 9 | ## Properties 10 | 11 | ### clientId 12 | 13 | > **clientId**: `string` 14 | 15 | The client id, which can be used to send information to clients 16 | 17 | #### Defined in 18 | 19 | [adapter/src/lib/\_Types.ts:138](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L138) 20 | 21 | *** 22 | 23 | ### message 24 | 25 | > **message**: [`Message`](Message.md) 26 | 27 | The message used for subscription 28 | 29 | #### Defined in 30 | 31 | [adapter/src/lib/\_Types.ts:140](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L140) 32 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/interfaces/ValidateIdOptions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ValidateIdOptions 6 | 7 | # Interface: ValidateIdOptions 8 | 9 | ## Properties 10 | 11 | ### maintenance? 12 | 13 | > `optional` **maintenance**: `boolean` 14 | 15 | in maintenance mode, we can access invalid ids to delete them, only works with the admin user 16 | 17 | #### Defined in 18 | 19 | [adapter/src/lib/adapter/validator.ts:10](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/adapter/validator.ts#L10) 20 | 21 | *** 22 | 23 | ### user? 24 | 25 | > `optional` **user**: `string` 26 | 27 | User used to check for access rights 28 | 29 | #### Defined in 30 | 31 | [adapter/src/lib/adapter/validator.ts:12](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/adapter/validator.ts#L12) 32 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/Adapter.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Adapter 6 | 7 | # Type Alias: Adapter 8 | 9 | > **Adapter**: \`system.adapter.$\{string\}\` \| \`system.host.$\{string\}.adapter.$\{string\}\` 10 | 11 | ## Defined in 12 | 13 | [types-dev/objects.d.ts:83](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L83) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/AdapterScopedObject.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / AdapterScopedObject 6 | 7 | # Type Alias: AdapterScopedObject 8 | 9 | > **AdapterScopedObject**: [`FolderObject`](../interfaces/FolderObject.md) \| [`DeviceObject`](../interfaces/DeviceObject.md) \| [`ChannelObject`](../interfaces/ChannelObject.md) \| [`StateObject`](../interfaces/StateObject.md) 10 | 11 | All objects that usually appear in an adapter scope 12 | 13 | ## Defined in 14 | 15 | [types-dev/objects.d.ts:1253](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L1253) 16 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/AtLeastOne.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / AtLeastOne 6 | 7 | # Type Alias: AtLeastOne\ 8 | 9 | > **AtLeastOne**\<`T`, `Req`, `Opt`\>: `{ [K in keyof Req]: Omit & { [P in K]: Req[P] } }`\[keyof `Req`\] 10 | 11 | ## Type Parameters 12 | 13 | • **T** 14 | 15 | • **Req** = `{ [K in keyof T]-?: T[K] }` 16 | 17 | • **Opt** = `{ [K in keyof T]?: T[K] }` 18 | 19 | ## Defined in 20 | 21 | [types-dev/index.d.ts:15](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L15) 22 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/AutoUpgradePolicy.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / AutoUpgradePolicy 6 | 7 | # Type Alias: AutoUpgradePolicy 8 | 9 | > **AutoUpgradePolicy**: `"none"` \| `"patch"` \| `"minor"` \| `"major"` 10 | 11 | ## Defined in 12 | 13 | [types-dev/objects.d.ts:504](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L504) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/Brand.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Brand 6 | 7 | # Type Alias: Brand\ 8 | 9 | > **Brand**\<`B`\>: `object` 10 | 11 | ## Type Parameters 12 | 13 | • **B** 14 | 15 | ## Type declaration 16 | 17 | ### \[\_\_\_brand\] 18 | 19 | > **\[\_\_\_brand\]**: `B` 20 | 21 | ## Defined in 22 | 23 | [types-dev/utils.d.ts:2](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/utils.d.ts#L2) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/Branded.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Branded 6 | 7 | # Type Alias: Branded\ 8 | 9 | > **Branded**\<`T`, `B`\>: `T` & [`Brand`](Brand.md)\<`B`\> 10 | 11 | ## Type Parameters 12 | 13 | • **T** 14 | 15 | • **B** 16 | 17 | ## Defined in 18 | 19 | [types-dev/utils.d.ts:3](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/utils.d.ts#L3) 20 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/CalculatePermissionsCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / CalculatePermissionsCallback 6 | 7 | # Type Alias: CalculatePermissionsCallback() 8 | 9 | > **CalculatePermissionsCallback**: (`result`) => `void` 10 | 11 | ## Parameters 12 | 13 | • **result**: [`PermissionSet`](../interfaces/PermissionSet.md) 14 | 15 | ## Returns 16 | 17 | `void` 18 | 19 | ## Defined in 20 | 21 | [adapter/src/lib/\_Types.ts:313](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L313) 22 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/Callback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Callback 6 | 7 | # Type Alias: Callback() 8 | 9 | > **Callback**: (...`args`) => `void` \| `Promise`\<`void`\> 10 | 11 | ## Parameters 12 | 13 | • ...**args**: `any`[] 14 | 15 | ## Returns 16 | 17 | `void` \| `Promise`\<`void`\> 18 | 19 | ## Defined in 20 | 21 | [adapter/src/lib/adapter/validator.ts:4](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/adapter/validator.ts#L4) 22 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/CallbackReturnTypeOf.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / CallbackReturnTypeOf 6 | 7 | # Type Alias: CallbackReturnTypeOf\ 8 | 9 | > **CallbackReturnTypeOf**\<`T`\>: [`SecondParameterOf`](SecondParameterOf.md)\<`T`\> 10 | 11 | Infers the return type from a callback-style API and leaves null and undefined in 12 | 13 | ## Type Parameters 14 | 15 | • **T** *extends* (...`args`) => `any` 16 | 17 | ## Defined in 18 | 19 | [types-dev/index.d.ts:466](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L466) 20 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/ChangeFunction.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ChangeFunction 6 | 7 | # Type Alias: ChangeFunction() 8 | 9 | > **ChangeFunction**: (`id`, `object`) => `void` 10 | 11 | ## Parameters 12 | 13 | • **id**: `string` 14 | 15 | • **object**: [`Object`](Object.md) \| `null` 16 | 17 | ## Returns 18 | 19 | `void` 20 | 21 | ## Defined in 22 | 23 | db-objects-redis/build/esm/lib/objects/objectsInRedisClient.d.ts:4 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/Channel.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Channel 6 | 7 | # Type Alias: Channel 8 | 9 | > **Channel**: \`script.js.$\{"common" \| "global"\}\` \| \`$\{string\}.$\{number\}.info\` 10 | 11 | ## Defined in 12 | 13 | [types-dev/objects.d.ts:73](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L73) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/CheckFileCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / CheckFileCallback 6 | 7 | # Type Alias: CheckFileCallback() 8 | 9 | > **CheckFileCallback**: (`checkFailed`, `options`?, `fileOptions`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **checkFailed**: `boolean` 14 | 15 | • **options?**: [`CallOptions`](../interfaces/CallOptions.md) 16 | 17 | • **fileOptions?** 18 | 19 | • **fileOptions.notExists?**: `boolean` 20 | 21 | ## Returns 22 | 23 | `void` 24 | 25 | ## Defined in 26 | 27 | db-objects-redis/build/esm/lib/objects/objectsInRedisClient.d.ts:43 28 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/CheckFileRightsCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / CheckFileRightsCallback 6 | 7 | # Type Alias: CheckFileRightsCallback() 8 | 9 | > **CheckFileRightsCallback**: (`err`, `options`, `opt`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err**: `Error` \| `null` \| `undefined` 14 | 15 | • **options**: `Record`\<`string`, `any`\> 16 | 17 | • **opt?**: `any` 18 | 19 | ## Returns 20 | 21 | `void` 22 | 23 | ## Defined in 24 | 25 | db-objects-redis/build/esm/lib/objects/objectsUtils.d.ts:33 26 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/CheckGroupCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / CheckGroupCallback 6 | 7 | # Type Alias: CheckGroupCallback() 8 | 9 | > **CheckGroupCallback**: (`result`) => `void` 10 | 11 | ## Parameters 12 | 13 | • **result**: `boolean` 14 | 15 | ## Returns 16 | 17 | `void` 18 | 19 | ## Defined in 20 | 21 | [adapter/src/lib/\_Types.ts:294](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L294) 22 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/CheckPasswordCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / CheckPasswordCallback 6 | 7 | # Type Alias: CheckPasswordCallback() 8 | 9 | > **CheckPasswordCallback**: (`success`, `user`) => `void` 10 | 11 | ## Parameters 12 | 13 | • **success**: `boolean` 14 | 15 | • **user**: `string` 16 | 17 | ## Returns 18 | 19 | `void` 20 | 21 | ## Defined in 22 | 23 | [adapter/src/lib/\_Types.ts:274](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L274) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/CheckStateCommand.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / CheckStateCommand 6 | 7 | # Type Alias: CheckStateCommand 8 | 9 | > **CheckStateCommand**: `"getState"` \| `"setState"` \| `"delState"` 10 | 11 | ## Defined in 12 | 13 | [adapter/src/lib/\_Types.ts:247](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L247) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/ChownFileCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ChownFileCallback 6 | 7 | # Type Alias: ChownFileCallback() 8 | 9 | > **ChownFileCallback**: (`err`?, `processed`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err?**: `NodeJS.ErrnoException` \| `null` 14 | 15 | • **processed?**: [`ChownFileResult`](../interfaces/ChownFileResult.md)[] 16 | 17 | ## Returns 18 | 19 | `void` 20 | 21 | ## Defined in 22 | 23 | [types-dev/index.d.ts:528](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L528) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/ChownObjectCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ChownObjectCallback 6 | 7 | # Type Alias: ChownObjectCallback() 8 | 9 | > **ChownObjectCallback**: (`err`?, `list`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err?**: `NodeJS.ErrnoException` \| `null` 14 | 15 | • **list?**: [`Object`](Object.md)[] 16 | 17 | ## Returns 18 | 19 | `void` 20 | 21 | ## Defined in 22 | 23 | [types-dev/index.d.ts:539](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L539) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/ClientUnsubscribeReason.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ClientUnsubscribeReason 6 | 7 | # Type Alias: ClientUnsubscribeReason 8 | 9 | > **ClientUnsubscribeReason**: [`MessageUnsubscribeReason`](MessageUnsubscribeReason.md) \| `"clientSubscribeError"` 10 | 11 | ## Defined in 12 | 13 | [adapter/src/lib/\_Types.ts:68](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L68) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/CommandsPermissions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / CommandsPermissions 6 | 7 | # Type Alias: CommandsPermissions 8 | 9 | > **CommandsPermissions**: [`CommandsPermissionsObject`](CommandsPermissionsObject.md) \| [`CommandsPermissionsEntry`](CommandsPermissionsEntry.md)[] 10 | 11 | ## Defined in 12 | 13 | [adapter/src/lib/\_Types.ts:311](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L311) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/CommandsPermissionsEntry.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / CommandsPermissionsEntry 6 | 7 | # Type Alias: CommandsPermissionsEntry 8 | 9 | > **CommandsPermissionsEntry**: `object` 10 | 11 | ## Type declaration 12 | 13 | ### operation 14 | 15 | > **operation**: `string` 16 | 17 | ### type 18 | 19 | > **type**: `"object"` \| `"state"` \| `""` \| `"other"` \| `"file"` 20 | 21 | ## Defined in 22 | 23 | [adapter/src/lib/\_Types.ts:303](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L303) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/CommandsPermissionsObject.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / CommandsPermissionsObject 6 | 7 | # Type Alias: CommandsPermissionsObject 8 | 9 | > **CommandsPermissionsObject**: `object` 10 | 11 | ## Index Signature 12 | 13 | \[`permission`: `string`\]: [`CommandsPermissionsEntry`](CommandsPermissionsEntry.md) 14 | 15 | ## Defined in 16 | 17 | [adapter/src/lib/\_Types.ts:307](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L307) 18 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/CommonType.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / CommonType 6 | 7 | # Type Alias: CommonType 8 | 9 | > **CommonType**: `"number"` \| `"string"` \| `"boolean"` \| `"array"` \| `"object"` \| `"mixed"` 10 | 11 | ## Defined in 12 | 13 | [types-dev/objects.d.ts:164](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L164) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/ConnectionType.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ConnectionType 6 | 7 | # Type Alias: ConnectionType 8 | 9 | > **ConnectionType**: `"local"` \| `"cloud"` 10 | 11 | ## Defined in 12 | 13 | [types-dev/objects.d.ts:575](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L575) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/DeleteStateCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / DeleteStateCallback 6 | 7 | # Type Alias: DeleteStateCallback() 8 | 9 | > **DeleteStateCallback**: (`err`?, `id`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err?**: `Error` \| `null` 14 | 15 | • **id?**: `string` 16 | 17 | ## Returns 18 | 19 | `void` 20 | 21 | ## Defined in 22 | 23 | [types-dev/index.d.ts:480](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L480) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/Dependencies.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Dependencies 6 | 7 | # Type Alias: Dependencies 8 | 9 | > **Dependencies**: `object`[] \| `string`[] 10 | 11 | Format for local and global dependencies 12 | 13 | ## Defined in 14 | 15 | [types-dev/objects.d.ts:599](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L599) 16 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/EmptyCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / EmptyCallback 6 | 7 | # Type Alias: EmptyCallback() 8 | 9 | > **EmptyCallback**: () => `void` 10 | 11 | ## Returns 12 | 13 | `void` 14 | 15 | ## Defined in 16 | 17 | [types-dev/index.d.ts:402](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L402) 18 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/Enum.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Enum 6 | 7 | # Type Alias: Enum 8 | 9 | > **Enum**: \`enum.$\{string\}\` 10 | 11 | ## Defined in 12 | 13 | [types-dev/objects.d.ts:79](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L79) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/EnumList.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / EnumList 6 | 7 | # Type Alias: EnumList 8 | 9 | > **EnumList**: `string` \| `string`[] 10 | 11 | ## Defined in 12 | 13 | [types-dev/index.d.ts:282](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L282) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/ErrnoCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ErrnoCallback 6 | 7 | # Type Alias: ErrnoCallback() 8 | 9 | > **ErrnoCallback**: (`err`?) => `void` 10 | 11 | Special variant of ErrorCallback for methods where Node.js returns an ErrnoException 12 | 13 | ## Parameters 14 | 15 | • **err?**: `NodeJS.ErrnoException` \| `null` 16 | 17 | ## Returns 18 | 19 | `void` 20 | 21 | ## Defined in 22 | 23 | [types-dev/index.d.ts:405](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L405) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/ErrorCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ErrorCallback 6 | 7 | # Type Alias: ErrorCallback() 8 | 9 | > **ErrorCallback**: (`err`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err?**: `Error` \| `null` 14 | 15 | ## Returns 16 | 17 | `void` 18 | 19 | ## Defined in 20 | 21 | [types-dev/index.d.ts:403](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L403) 22 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/ErrorHandler.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ErrorHandler 6 | 7 | # Type Alias: ErrorHandler() 8 | 9 | > **ErrorHandler**: (`err`) => `boolean` 10 | 11 | ## Parameters 12 | 13 | • **err**: `Error` 14 | 15 | ## Returns 16 | 17 | `boolean` 18 | 19 | ## Defined in 20 | 21 | [types-dev/index.d.ts:400](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L400) 22 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/ExtendObjectCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ExtendObjectCallback 6 | 7 | # Type Alias: ExtendObjectCallback() 8 | 9 | > **ExtendObjectCallback**: (`err`?, `result`?, `id`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err?**: `Error` \| `null` 14 | 15 | • **result?** 16 | 17 | • **result.id?**: `string` 18 | 19 | • **result.value?**: [`Object`](Object.md) 20 | 21 | • **id?**: `string` 22 | 23 | ## Returns 24 | 25 | `void` 26 | 27 | ## Defined in 28 | 29 | [types-dev/index.d.ts:567](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L567) 30 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/FileChangeHandler.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / FileChangeHandler 6 | 7 | # Type Alias: FileChangeHandler() 8 | 9 | > **FileChangeHandler**: (`id`, `fileName`, `size`) => `void` 10 | 11 | ## Parameters 12 | 13 | • **id**: `string` 14 | 15 | • **fileName**: `string` 16 | 17 | • **size**: `number` \| `null` 18 | 19 | ## Returns 20 | 21 | `void` 22 | 23 | ## Defined in 24 | 25 | [types-dev/index.d.ts:397](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L397) 26 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/FindObjectCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / FindObjectCallback 6 | 7 | # Type Alias: FindObjectCallback() 8 | 9 | > **FindObjectCallback**: (`err`?, `id`?, `name`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err?**: `Error` \| `null` 14 | 15 | • **id?**: `string` 16 | 17 | • **name?**: [`StringOrTranslated`](StringOrTranslated.md) 18 | 19 | ## Returns 20 | 21 | `void` 22 | 23 | ## Defined in 24 | 25 | [types-dev/index.d.ts:441](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L441) 26 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GenericCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GenericCallback 6 | 7 | # Type Alias: GenericCallback()\ 8 | 9 | > **GenericCallback**\<`T`\>: (`err`?, `result`?) => `void` 10 | 11 | ## Type Parameters 12 | 13 | • **T** 14 | 15 | ## Parameters 16 | 17 | • **err?**: `Error` \| `null` 18 | 19 | • **result?**: `T` 20 | 21 | ## Returns 22 | 23 | `void` 24 | 25 | ## Defined in 26 | 27 | [types-dev/index.d.ts:407](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L407) 28 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetCertificatesCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetCertificatesCallback 6 | 7 | # Type Alias: GetCertificatesCallback() 8 | 9 | > **GetCertificatesCallback**: (`err`?, `certs`?, `useLetsEncryptCert`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err?**: `Error` \| `null` 14 | 15 | • **certs?**: [`Certificates`](../interfaces/Certificates.md) 16 | 17 | • **useLetsEncryptCert?**: `boolean` 18 | 19 | ## Returns 20 | 21 | `void` 22 | 23 | ## Defined in 24 | 25 | [adapter/src/lib/\_Types.ts:331](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L331) 26 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetCertificatesPromiseReturnType.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetCertificatesPromiseReturnType 6 | 7 | # Type Alias: GetCertificatesPromiseReturnType 8 | 9 | > **GetCertificatesPromiseReturnType**: [[`Certificates`](../interfaces/Certificates.md), `boolean`] 10 | 11 | ## Defined in 12 | 13 | [adapter/src/lib/\_Types.ts:337](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L337) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetEncryptedConfigCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetEncryptedConfigCallback 6 | 7 | # Type Alias: GetEncryptedConfigCallback() 8 | 9 | > **GetEncryptedConfigCallback**: (`error`, `result`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **error**: `Error` \| `null` \| `undefined` 14 | 15 | • **result?**: `string` \| `string`[] 16 | 17 | ## Returns 18 | 19 | `void` 20 | 21 | ## Defined in 22 | 23 | [adapter/src/lib/\_Types.ts:350](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L350) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetEnumCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetEnumCallback 6 | 7 | # Type Alias: GetEnumCallback() 8 | 9 | > **GetEnumCallback**: (`err`?, `enums`?, `requestedEnum`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err?**: `Error` \| `null` 14 | 15 | • **enums?**: `Record`\<`string`, [`EnumObject`](../interfaces/EnumObject.md)\> 16 | 17 | • **requestedEnum?**: `string` 18 | 19 | ## Returns 20 | 21 | `void` 22 | 23 | ## Defined in 24 | 25 | [types-dev/index.d.ts:421](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L421) 26 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetEnumsCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetEnumsCallback 6 | 7 | # Type Alias: GetEnumsCallback() 8 | 9 | > **GetEnumsCallback**: (`err`?, `result`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err?**: `Error` \| `null` 14 | 15 | • **result?** 16 | 17 | ## Returns 18 | 19 | `void` 20 | 21 | ## Defined in 22 | 23 | [types-dev/index.d.ts:422](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L422) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetEnumsPromise.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetEnumsPromise 6 | 7 | # Type Alias: GetEnumsPromise 8 | 9 | > **GetEnumsPromise**: `Promise`\<[`NonNullCallbackReturnTypeOf`](NonNullCallbackReturnTypeOf.md)\<[`GetEnumsCallback`](GetEnumsCallback.md)\>\> 10 | 11 | ## Defined in 12 | 13 | [types-dev/index.d.ts:428](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L428) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetHistoryCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetHistoryCallback 6 | 7 | # Type Alias: GetHistoryCallback() 8 | 9 | > **GetHistoryCallback**: (`err`, `result`?, `step`?, `sessionId`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err**: `Error` \| `null` 14 | 15 | • **result?**: [`GetHistoryResult`](GetHistoryResult.md) 16 | 17 | • **step?**: `number` 18 | 19 | • **sessionId?**: `number` 20 | 21 | ## Returns 22 | 23 | `void` 24 | 25 | ## Defined in 26 | 27 | [types-dev/index.d.ts:483](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L483) 28 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetHistoryResult.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetHistoryResult 6 | 7 | # Type Alias: GetHistoryResult 8 | 9 | > **GetHistoryResult**: [`State`](../interfaces/State.md) & `object`[] 10 | 11 | ## Defined in 12 | 13 | [types-dev/index.d.ts:482](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L482) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetKeysCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetKeysCallback 6 | 7 | # Type Alias: GetKeysCallback() 8 | 9 | > **GetKeysCallback**: (`err`?, `list`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err?**: `Error` \| `null` 14 | 15 | • **list?**: `string`[] 16 | 17 | ## Returns 18 | 19 | `void` 20 | 21 | ## Defined in 22 | 23 | [types-dev/index.d.ts:541](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L541) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetObjectCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetObjectCallback 6 | 7 | # Type Alias: GetObjectCallback()\ 8 | 9 | > **GetObjectCallback**\<`T`\>: (`err`?, `obj`?) => `void` 10 | 11 | ## Type Parameters 12 | 13 | • **T** *extends* `string` = `string` 14 | 15 | ## Parameters 16 | 17 | • **err?**: `Error` \| `null` 18 | 19 | • **obj?**: [`ObjectIdToObjectType`](ObjectIdToObjectType.md)\<`T`\> \| `null` 20 | 21 | ## Returns 22 | 23 | `void` 24 | 25 | ## Defined in 26 | 27 | [types-dev/index.d.ts:415](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L415) 28 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetObjectListCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetObjectListCallback 6 | 7 | # Type Alias: GetObjectListCallback()\ 8 | 9 | > **GetObjectListCallback**\<`T`\>: (`err`?, `result`?) => `void` 10 | 11 | ## Type Parameters 12 | 13 | • **T** *extends* [`Object`](Object.md) 14 | 15 | ## Parameters 16 | 17 | • **err?**: `Error` \| `null` 18 | 19 | • **result?** 20 | 21 | • **result.rows?**: [`GetObjectListItem`](../interfaces/GetObjectListItem.md)\<`T`\>[] 22 | 23 | ## Returns 24 | 25 | `void` 26 | 27 | ## Defined in 28 | 29 | [types-dev/index.d.ts:561](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L561) 30 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetObjectListPromise.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetObjectListPromise 6 | 7 | # Type Alias: GetObjectListPromise 8 | 9 | > **GetObjectListPromise**: `Promise`\<[`NonNullCallbackReturnTypeOf`](NonNullCallbackReturnTypeOf.md)\<[`GetObjectListCallback`](GetObjectListCallback.md)\<[`Object`](Object.md)\>\>\> 10 | 11 | ## Defined in 12 | 13 | [types-dev/index.d.ts:565](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L565) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetObjectPromise.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetObjectPromise 6 | 7 | # Type Alias: GetObjectPromise\ 8 | 9 | > **GetObjectPromise**\<`T`\>: `Promise`\<[`CallbackReturnTypeOf`](CallbackReturnTypeOf.md)\<[`GetObjectCallback`](GetObjectCallback.md)\<`T`\>\>\> 10 | 11 | ## Type Parameters 12 | 13 | • **T** *extends* `string` = `string` 14 | 15 | ## Defined in 16 | 17 | [types-dev/index.d.ts:419](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L419) 18 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetObjectViewCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetObjectViewCallback 6 | 7 | # Type Alias: GetObjectViewCallback()\ 8 | 9 | > **GetObjectViewCallback**\<`T`\>: (`err`?, `result`?) => `void` 10 | 11 | ## Type Parameters 12 | 13 | • **T** *extends* [`AnyObject`](AnyObject.md) 14 | 15 | ## Parameters 16 | 17 | • **err?**: `Error` \| `null` 18 | 19 | • **result?** 20 | 21 | • **result.rows?**: [`GetObjectViewItem`](../interfaces/GetObjectViewItem.md)\<`T`\>[] 22 | 23 | ## Returns 24 | 25 | `void` 26 | 27 | ## Defined in 28 | 29 | [types-dev/index.d.ts:549](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L549) 30 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetObjectViewPromise.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetObjectViewPromise 6 | 7 | # Type Alias: GetObjectViewPromise\ 8 | 9 | > **GetObjectViewPromise**\<`T`\>: `Promise`\<[`NonNullCallbackReturnTypeOf`](NonNullCallbackReturnTypeOf.md)\<[`GetObjectViewCallback`](GetObjectViewCallback.md)\<`T`\>\>\> 10 | 11 | ## Type Parameters 12 | 13 | • **T** *extends* [`AnyObject`](AnyObject.md) 14 | 15 | ## Defined in 16 | 17 | [types-dev/index.d.ts:553](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L553) 18 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetObjectsCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetObjectsCallback 6 | 7 | # Type Alias: GetObjectsCallback() 8 | 9 | > **GetObjectsCallback**: (`err`?, `objects`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err?**: `Error` \| `null` 14 | 15 | • **objects?**: `Record`\<`string`, [`Object`](Object.md)\> 16 | 17 | ## Returns 18 | 19 | `void` 20 | 21 | ## Defined in 22 | 23 | [types-dev/index.d.ts:430](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L430) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetObjectsCallback3.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetObjectsCallback3 6 | 7 | # Type Alias: GetObjectsCallback3()\ 8 | 9 | > **GetObjectsCallback3**\<`T`\>: (`err`?, `result`?) => `void` 10 | 11 | ## Type Parameters 12 | 13 | • **T** *extends* [`BaseObject`](../interfaces/BaseObject.md) 14 | 15 | ## Parameters 16 | 17 | • **err?**: `Error` \| `null` 18 | 19 | • **result?**: `T`[] 20 | 21 | ## Returns 22 | 23 | `void` 24 | 25 | ## Defined in 26 | 27 | [types-dev/index.d.ts:451](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L451) 28 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetObjectsCallbackTyped.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetObjectsCallbackTyped 6 | 7 | # Type Alias: GetObjectsCallbackTyped()\ 8 | 9 | > **GetObjectsCallbackTyped**\<`T`\>: (`err`?, `objects`?) => `void` 10 | 11 | ## Type Parameters 12 | 13 | • **T** *extends* [`ObjectType`](ObjectType.md) 14 | 15 | ## Parameters 16 | 17 | • **err?**: `Error` \| `null` 18 | 19 | • **objects?**: `Record`\<`string`, [`AnyObject`](AnyObject.md) & `object`\> 20 | 21 | ## Returns 22 | 23 | `void` 24 | 25 | ## Defined in 26 | 27 | [types-dev/index.d.ts:433](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L433) 28 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetObjectsPromise.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetObjectsPromise 6 | 7 | # Type Alias: GetObjectsPromise 8 | 9 | > **GetObjectsPromise**: `Promise`\<[`NonNullCallbackReturnTypeOf`](NonNullCallbackReturnTypeOf.md)\<[`GetObjectsCallback`](GetObjectsCallback.md)\>\> 10 | 11 | ## Defined in 12 | 13 | [types-dev/index.d.ts:431](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L431) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetObjectsPromiseTyped.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetObjectsPromiseTyped 6 | 7 | # Type Alias: GetObjectsPromiseTyped\ 8 | 9 | > **GetObjectsPromiseTyped**\<`T`\>: `Promise`\<[`NonNullCallbackReturnTypeOf`](NonNullCallbackReturnTypeOf.md)\<[`GetObjectsCallbackTyped`](GetObjectsCallbackTyped.md)\<`T`\>\>\> 10 | 11 | ## Type Parameters 12 | 13 | • **T** *extends* [`ObjectType`](ObjectType.md) 14 | 15 | ## Defined in 16 | 17 | [types-dev/index.d.ts:437](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L437) 18 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetSessionCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetSessionCallback 6 | 7 | # Type Alias: GetSessionCallback() 8 | 9 | > **GetSessionCallback**: (`session`) => `void` 10 | 11 | ## Parameters 12 | 13 | • **session**: [`Session`](Session.md) 14 | 15 | ## Returns 16 | 17 | `void` 18 | 19 | ## Defined in 20 | 21 | [types-dev/index.d.ts:573](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L573) 22 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetStateCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetStateCallback 6 | 7 | # Type Alias: GetStateCallback() 8 | 9 | > **GetStateCallback**: (`err`?, `state`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err?**: `Error` \| `null` 14 | 15 | • **state?**: [`State`](../interfaces/State.md) \| `null` 16 | 17 | ## Returns 18 | 19 | `void` 20 | 21 | ## Defined in 22 | 23 | [types-dev/index.d.ts:468](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L468) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetStatePromise.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetStatePromise 6 | 7 | # Type Alias: GetStatePromise 8 | 9 | > **GetStatePromise**: `Promise`\<[`CallbackReturnTypeOf`](CallbackReturnTypeOf.md)\<[`GetStateCallback`](GetStateCallback.md)\>\> 10 | 11 | ## Defined in 12 | 13 | [types-dev/index.d.ts:469](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L469) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetStatesCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetStatesCallback 6 | 7 | # Type Alias: GetStatesCallback() 8 | 9 | > **GetStatesCallback**: (`err`?, `states`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err?**: `Error` \| `null` 14 | 15 | • **states?**: `Record`\<`string`, [`State`](../interfaces/State.md)\> 16 | 17 | ## Returns 18 | 19 | `void` 20 | 21 | ## Defined in 22 | 23 | [types-dev/index.d.ts:471](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L471) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetStatesPromise.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetStatesPromise 6 | 7 | # Type Alias: GetStatesPromise 8 | 9 | > **GetStatesPromise**: `Promise`\<[`NonNullCallbackReturnTypeOf`](NonNullCallbackReturnTypeOf.md)\<[`GetStatesCallback`](GetStatesCallback.md)\>\> 10 | 11 | ## Defined in 12 | 13 | [types-dev/index.d.ts:472](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L472) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetUserGroupCallbackNoError.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetUserGroupCallbackNoError 6 | 7 | # Type Alias: GetUserGroupCallbackNoError() 8 | 9 | > **GetUserGroupCallbackNoError**: (`user`, `groups`, `acl`) => `void` 10 | 11 | ## Parameters 12 | 13 | • **user**: `string` 14 | 15 | • **groups**: `string`[] 16 | 17 | • **acl**: [`ObjectPermissions`](../interfaces/ObjectPermissions.md) 18 | 19 | ## Returns 20 | 21 | `void` 22 | 23 | ## Defined in 24 | 25 | db-objects-redis/build/esm/lib/objects/objectsInRedisClient.d.ts:5 26 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/GetUserGroupPromiseReturn.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / GetUserGroupPromiseReturn 6 | 7 | # Type Alias: GetUserGroupPromiseReturn 8 | 9 | > **GetUserGroupPromiseReturn**: [`string`, `string`[], [`ObjectPermissions`](../interfaces/ObjectPermissions.md)] 10 | 11 | ## Defined in 12 | 13 | db-objects-redis/build/esm/lib/objects/objectsUtils.d.ts:43 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/Group.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Group 6 | 7 | # Type Alias: Group 8 | 9 | > **Group**: \`system.group.$\{string\}\` 10 | 11 | ## Defined in 12 | 13 | [types-dev/objects.d.ts:85](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L85) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/InstalledFrom.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / InstalledFrom 6 | 7 | # Type Alias: InstalledFrom 8 | 9 | > **InstalledFrom**: [`Branded`](Branded.md)\<`string`, `"InstalledFrom"`\> 10 | 11 | Installed from attribute of instance/adapter object 12 | 13 | ## Defined in 14 | 15 | [types-dev/objects.d.ts:345](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L345) 16 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/Instance.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Instance 6 | 7 | # Type Alias: Instance 8 | 9 | > **Instance**: \`system.adapter.$\{string\}.$\{number\}\` 10 | 11 | ## Defined in 12 | 13 | [types-dev/objects.d.ts:81](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L81) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/InstanceMode.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / InstanceMode 6 | 7 | # Type Alias: InstanceMode 8 | 9 | > **InstanceMode**: `"none"` \| `"daemon"` \| `"schedule"` \| `"once"` \| `"extension"` 10 | 11 | ## Defined in 12 | 13 | [types-dev/objects.d.ts:333](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L333) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/InternalLogger.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / InternalLogger 6 | 7 | # Type Alias: InternalLogger 8 | 9 | > **InternalLogger**: `Omit`\<[`Logger`](../interfaces/Logger.md), `"level"`\> 10 | 11 | ## Defined in 12 | 13 | common-db/build/esm/lib/common/tools.d.ts:606 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/Interval.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Interval 6 | 7 | # Type Alias: Interval 8 | 9 | > **Interval**: [`Branded`](Branded.md)\<`number`, `"Interval"`\> \| `null` 10 | 11 | ## Defined in 12 | 13 | [types-dev/index.d.ts:576](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L576) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/IoBrokerJson.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / IoBrokerJson 6 | 7 | # Type Alias: IoBrokerJson 8 | 9 | > **IoBrokerJson**: [`IoBJson`](../interfaces/IoBJson.md) 10 | 11 | The ioBroker global config 12 | 13 | ## Defined in 14 | 15 | [types-dev/index.d.ts:581](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L581) 16 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/Languages.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Languages 6 | 7 | # Type Alias: Languages 8 | 9 | > **Languages**: `"en"` \| `"de"` \| `"ru"` \| `"pt"` \| `"nl"` \| `"fr"` \| `"it"` \| `"es"` \| `"pl"` \| `"uk"` \| `"zh-cn"` 10 | 11 | ## Defined in 12 | 13 | [types-dev/objects.d.ts:158](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L158) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/LicenseInformation.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / LicenseInformation 6 | 7 | # Type Alias: LicenseInformation 8 | 9 | > **LicenseInformation**: [`LicenseInformationFree`](../interfaces/LicenseInformationFree.md) \| [`LicenseInformationWithPayment`](../interfaces/LicenseInformationWithPayment.md) 10 | 11 | ## Defined in 12 | 13 | [types-dev/objects.d.ts:543](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L543) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/LogFunction.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / LogFunction 6 | 7 | # Type Alias: LogFunction() 8 | 9 | > **LogFunction**: (`msg`) => `void` 10 | 11 | ## Parameters 12 | 13 | • **msg**: `string` 14 | 15 | ## Returns 16 | 17 | `void` 18 | 19 | ## Defined in 20 | 21 | [adapter/src/lib/adapter/log.ts:1](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/adapter/log.ts#L1) 22 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/LogLevel.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / LogLevel 6 | 7 | # Type Alias: LogLevel 8 | 9 | > **LogLevel**: `"silly"` \| `"debug"` \| `"info"` \| `"warn"` \| `"error"` 10 | 11 | ## Defined in 12 | 13 | [types-dev/index.d.ts:209](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L209) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/LogMessageInternal.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / LogMessageInternal 6 | 7 | # Type Alias: LogMessageInternal 8 | 9 | > **LogMessageInternal**: `Omit`\<[`LogMessage`](../interfaces/LogMessage.md), `"_id"`\> 10 | 11 | The internal log message does not have an _id parameter 12 | 13 | ## Defined in 14 | 15 | db-states-redis/build/esm/lib/states/statesInRedisClient.d.ts:31 16 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/MaybePromise.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / MaybePromise 6 | 7 | # Type Alias: MaybePromise 8 | 9 | > **MaybePromise**: `Promise`\<`void`\> \| `void` 10 | 11 | ## Defined in 12 | 13 | [adapter/src/lib/\_Types.ts:249](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L249) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/MessageCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / MessageCallback 6 | 7 | # Type Alias: MessageCallback() 8 | 9 | > **MessageCallback**: (`response`?) => `void` 10 | 11 | Due to backward compatibility first param can be result or error 12 | 13 | ## Parameters 14 | 15 | • **response?**: [`Message`](../interfaces/Message.md) \| `Error` 16 | 17 | ## Returns 18 | 19 | `void` 20 | 21 | ## Defined in 22 | 23 | [types-dev/index.d.ts:410](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L410) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/MessageHandler.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / MessageHandler 6 | 7 | # Type Alias: MessageHandler() 8 | 9 | > **MessageHandler**: (`obj`) => `void` \| `Promise`\<`void`\> 10 | 11 | ## Parameters 12 | 13 | • **obj**: [`Message`](../interfaces/Message.md) 14 | 15 | ## Returns 16 | 17 | `void` \| `Promise`\<`void`\> 18 | 19 | ## Defined in 20 | 21 | [types-dev/index.d.ts:398](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L398) 22 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/MessageUnsubscribeReason.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / MessageUnsubscribeReason 6 | 7 | # Type Alias: MessageUnsubscribeReason 8 | 9 | > **MessageUnsubscribeReason**: `"client"` \| `"disconnect"` 10 | 11 | ## Defined in 12 | 13 | [adapter/src/lib/\_Types.ts:67](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L67) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/Meta.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Meta 6 | 7 | # Type Alias: Meta 8 | 9 | > **Meta**: \`$\{string\}.$\{number\}\` \| \`$\{string\}.$\{"meta" \| "admin"\}\` \| \`$\{string\}.meta.$\{string\}\` \| \`$\{string\}.$\{number\}.meta.$\{string\}\` 10 | 11 | ## Defined in 12 | 13 | [types-dev/objects.d.ts:62](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L62) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/Misc.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Misc 6 | 7 | # Type Alias: Misc 8 | 9 | > **Misc**: \`system.host.$\{string\}.$\{string\}\` \| \`0\_userdata.0.$\{string\}\` 10 | 11 | ## Defined in 12 | 13 | [types-dev/objects.d.ts:70](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L70) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/NonNullCallbackReturnTypeOf.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / NonNullCallbackReturnTypeOf 6 | 7 | # Type Alias: NonNullCallbackReturnTypeOf\ 8 | 9 | > **NonNullCallbackReturnTypeOf**\<`T`\>: `Exclude`\<[`SecondParameterOf`](SecondParameterOf.md)\<`T`\>, `null` \| `undefined`\> 10 | 11 | Infers the return type from a callback-style API and strips out null and undefined 12 | 13 | ## Type Parameters 14 | 15 | • **T** *extends* (...`args`) => `any` 16 | 17 | ## Defined in 18 | 19 | [types-dev/index.d.ts:461](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L461) 20 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/Object.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Object 6 | 7 | # Type Alias: Object 8 | 9 | > **Object**: [`AnyObject`](AnyObject.md) & `object` 10 | 11 | ## Type declaration 12 | 13 | ### common 14 | 15 | > **common**: `Record`\<`string`, `any`\> 16 | 17 | ### native 18 | 19 | > **native**: `Record`\<`string`, `any`\> 20 | 21 | ## Defined in 22 | 23 | [types-dev/objects.d.ts:1257](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L1257) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/ObjectChangeHandler.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ObjectChangeHandler 6 | 7 | # Type Alias: ObjectChangeHandler() 8 | 9 | > **ObjectChangeHandler**: (`id`, `obj`) => `void` \| `Promise`\<`void`\> 10 | 11 | ## Parameters 12 | 13 | • **id**: `string` 14 | 15 | • **obj**: [`Object`](Object.md) \| `null` \| `undefined` 16 | 17 | ## Returns 18 | 19 | `void` \| `Promise`\<`void`\> 20 | 21 | ## Defined in 22 | 23 | [types-dev/index.d.ts:395](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L395) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/ObjectType.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ObjectType 6 | 7 | # Type Alias: ObjectType 8 | 9 | > **ObjectType**: `"state"` \| `"channel"` \| `"device"` \| `"folder"` \| `"enum"` \| `"adapter"` \| `"config"` \| `"group"` \| `"host"` \| `"instance"` \| `"meta"` \| `"script"` \| `"user"` \| `"chart"` \| `"schedule"` \| `"design"` 10 | 11 | Defines the existing object types in ioBroker 12 | 13 | ## Defined in 14 | 15 | [types-dev/objects.d.ts:41](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L41) 16 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/OptionalCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / OptionalCallback 6 | 7 | # Type Alias: OptionalCallback 8 | 9 | > **OptionalCallback**: `undefined` \| [`Callback`](Callback.md) 10 | 11 | ## Defined in 12 | 13 | [adapter/src/lib/adapter/validator.ts:5](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/adapter/validator.ts#L5) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/PaidLicenseType.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / PaidLicenseType 6 | 7 | # Type Alias: PaidLicenseType 8 | 9 | > **PaidLicenseType**: `"paid"` \| `"commercial"` \| `"limited"` 10 | 11 | ## Defined in 12 | 13 | [types-dev/objects.d.ts:517](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L517) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/PartialChartObject.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / PartialChartObject 6 | 7 | # Type Alias: PartialChartObject 8 | 9 | > **PartialChartObject**: [`ChartObject`](../interfaces/ChartObject.md) 10 | 11 | ## Defined in 12 | 13 | [types-dev/objects.d.ts:995](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L995) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/PartialObjectWorker.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / PartialObjectWorker 6 | 7 | # Type Alias: PartialObjectWorker\ 8 | 9 | > **PartialObjectWorker**\<`T`\>: `T` *extends* [`AnyObject`](AnyObject.md) ? [`AnyPartialObject`](AnyPartialObject.md) & `object` : `never` 10 | 11 | ## Type Parameters 12 | 13 | • **T** 14 | 15 | ## Defined in 16 | 17 | [types-dev/objects.d.ts:1270](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L1270) 18 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/Pattern.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Pattern 6 | 7 | # Type Alias: Pattern 8 | 9 | > **Pattern**: `string` \| `string`[] 10 | 11 | ## Defined in 12 | 13 | [adapter/src/lib/adapter/validator.ts:6](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/adapter/validator.ts#L6) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/Plugin.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Plugin 6 | 7 | # Type Alias: Plugin 8 | 9 | > **Plugin**: `Record`\<`string`, `any`\> 10 | 11 | ## Defined in 12 | 13 | [types-dev/index.d.ts:284](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L284) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/ReadDirCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ReadDirCallback 6 | 7 | # Type Alias: ReadDirCallback() 8 | 9 | > **ReadDirCallback**: (`err`?, `entries`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err?**: `NodeJS.ErrnoException` \| `null` 14 | 15 | • **entries?**: [`ReadDirResult`](../interfaces/ReadDirResult.md)[] 16 | 17 | ## Returns 18 | 19 | `void` 20 | 21 | ## Defined in 22 | 23 | [types-dev/index.d.ts:505](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L505) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/ReadDirPromise.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ReadDirPromise 6 | 7 | # Type Alias: ReadDirPromise 8 | 9 | > **ReadDirPromise**: `Promise`\<[`ReadDirResult`](../interfaces/ReadDirResult.md)[]\> 10 | 11 | ## Defined in 12 | 13 | [types-dev/index.d.ts:506](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L506) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/ReadFileCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ReadFileCallback 6 | 7 | # Type Alias: ReadFileCallback() 8 | 9 | > **ReadFileCallback**: (`err`?, `data`?, `mimeType`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err?**: `NodeJS.ErrnoException` \| `null` 14 | 15 | • **data?**: `Buffer` \| `string` 16 | 17 | • **mimeType?**: `string` 18 | 19 | ## Returns 20 | 21 | `void` 22 | 23 | ## Defined in 24 | 25 | [types-dev/index.d.ts:508](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L508) 26 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/ReadFilePromise.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ReadFilePromise 6 | 7 | # Type Alias: ReadFilePromise 8 | 9 | > **ReadFilePromise**: `Promise`\<`object`\> 10 | 11 | ## Type declaration 12 | 13 | ### file 14 | 15 | > **file**: `string` \| `Buffer` 16 | 17 | ### mimeType? 18 | 19 | > `optional` **mimeType**: `string` 20 | 21 | ## Defined in 22 | 23 | [types-dev/index.d.ts:509](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L509) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/ReadyHandler.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ReadyHandler 6 | 7 | # Type Alias: ReadyHandler() 8 | 9 | > **ReadyHandler**: () => `void` \| `Promise`\<`void`\> 10 | 11 | ## Returns 12 | 13 | `void` \| `Promise`\<`void`\> 14 | 15 | ## Defined in 16 | 17 | [types-dev/index.d.ts:394](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L394) 18 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/RmCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / RmCallback 6 | 7 | # Type Alias: RmCallback() 8 | 9 | > **RmCallback**: (`err`?, `entries`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err?**: `NodeJS.ErrnoException` \| `null` 14 | 15 | • **entries?**: [`RmResult`](../interfaces/RmResult.md)[] 16 | 17 | ## Returns 18 | 19 | `void` 20 | 21 | ## Defined in 22 | 23 | [types-dev/index.d.ts:537](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L537) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/ScriptOrChannel.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / ScriptOrChannel 6 | 7 | # Type Alias: ScriptOrChannel 8 | 9 | > **ScriptOrChannel**: \`script.js.$\{string\}\` 10 | 11 | ## Defined in 12 | 13 | [types-dev/objects.d.ts:75](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L75) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/SecondParameterOf.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / SecondParameterOf 6 | 7 | # Type Alias: SecondParameterOf\ 8 | 9 | > **SecondParameterOf**\<`T`\>: `T` *extends* (`arg0`, `arg1`, ...`args`) => `any` ? `R` : `never` 10 | 11 | ## Type Parameters 12 | 13 | • **T** *extends* (...`args`) => `any` 14 | 15 | ## Defined in 16 | 17 | [types-dev/index.d.ts:453](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L453) 18 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/SendToAllClientOptions.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / SendToAllClientOptions 6 | 7 | # Type Alias: SendToAllClientOptions 8 | 9 | > **SendToAllClientOptions**: `Omit`\<[`SendToClientOptions`](../interfaces/SendToClientOptions.md), `"clientId"`\> 10 | 11 | ## Defined in 12 | 13 | [adapter/src/lib/adapter/userInterfaceMessagingController.ts:35](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/adapter/userInterfaceMessagingController.ts#L35) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/Session.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Session 6 | 7 | # Type Alias: Session 8 | 9 | > **Session**: `any` 10 | 11 | ## Defined in 12 | 13 | [types-dev/index.d.ts:97](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L97) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/SetObjectCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / SetObjectCallback 6 | 7 | # Type Alias: SetObjectCallback() 8 | 9 | > **SetObjectCallback**: (`err`?, `obj`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err?**: `Error` \| `null` 14 | 15 | • **obj?** 16 | 17 | • **obj.id?**: `string` 18 | 19 | ## Returns 20 | 21 | `void` 22 | 23 | ## Defined in 24 | 25 | [types-dev/index.d.ts:412](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L412) 26 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/SetObjectPromise.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / SetObjectPromise 6 | 7 | # Type Alias: SetObjectPromise 8 | 9 | > **SetObjectPromise**: `Promise`\<[`NonNullCallbackReturnTypeOf`](NonNullCallbackReturnTypeOf.md)\<[`SetObjectCallback`](SetObjectCallback.md)\>\> 10 | 11 | ## Defined in 12 | 13 | [types-dev/index.d.ts:413](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L413) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/SetStateCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / SetStateCallback 6 | 7 | # Type Alias: SetStateCallback() 8 | 9 | > **SetStateCallback**: (`err`?, `id`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err?**: `Error` \| `null` 14 | 15 | • **id?**: `string` 16 | 17 | ## Returns 18 | 19 | `void` 20 | 21 | ## Defined in 22 | 23 | [types-dev/index.d.ts:474](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L474) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/SetStateChangedCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / SetStateChangedCallback 6 | 7 | # Type Alias: SetStateChangedCallback() 8 | 9 | > **SetStateChangedCallback**: (`err`?, `id`?, `notChanged`?) => `void` 10 | 11 | ## Parameters 12 | 13 | • **err?**: `Error` \| `null` 14 | 15 | • **id?**: `string` 16 | 17 | • **notChanged?**: `boolean` 18 | 19 | ## Returns 20 | 21 | `void` 22 | 23 | ## Defined in 24 | 25 | [types-dev/index.d.ts:477](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L477) 26 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/SetStateChangedPromise.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / SetStateChangedPromise 6 | 7 | # Type Alias: SetStateChangedPromise 8 | 9 | > **SetStateChangedPromise**: `Promise`\<[`NonNullCallbackReturnTypeOf`](NonNullCallbackReturnTypeOf.md)\<[`SetStateChangedCallback`](SetStateChangedCallback.md)\>\> 10 | 11 | ## Defined in 12 | 13 | [types-dev/index.d.ts:478](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L478) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/SetStatePromise.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / SetStatePromise 6 | 7 | # Type Alias: SetStatePromise 8 | 9 | > **SetStatePromise**: `Promise`\<[`NonNullCallbackReturnTypeOf`](NonNullCallbackReturnTypeOf.md)\<[`SetStateCallback`](SetStateCallback.md)\>\> 10 | 11 | ## Defined in 12 | 13 | [types-dev/index.d.ts:475](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L475) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/SettableObjectWorker.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / SettableObjectWorker 6 | 7 | # Type Alias: SettableObjectWorker\ 8 | 9 | > **SettableObjectWorker**\<`T`\>: `T` *extends* [`AnyObject`](AnyObject.md) ? `Omit`\<`T`, `"_id"` \| `"acl"`\> & `object` : `never` 10 | 11 | ## Type Parameters 12 | 13 | • **T** 14 | 15 | ## Defined in 16 | 17 | [types-dev/objects.d.ts:1263](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L1263) 18 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/SettableState.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / SettableState 6 | 7 | # Type Alias: SettableState 8 | 9 | > **SettableState**: [`AtLeastOne`](AtLeastOne.md)\<[`State`](../interfaces/State.md)\> 10 | 11 | ## Defined in 12 | 13 | [types-dev/index.d.ts:89](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L89) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/State.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / State 6 | 7 | # Type Alias: State 8 | 9 | > **State**: \`system.adapter.$\{string\}.$\{number\}.$\{string\}\` 10 | 11 | ## Defined in 12 | 13 | [types-dev/objects.d.ts:77](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L77) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/StateChangeHandler.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / StateChangeHandler 6 | 7 | # Type Alias: StateChangeHandler() 8 | 9 | > **StateChangeHandler**: (`id`, `obj`) => `void` \| `Promise`\<`void`\> 10 | 11 | ## Parameters 12 | 13 | • **id**: `string` 14 | 15 | • **obj**: [`State`](../interfaces/State.md) \| `null` \| `undefined` 16 | 17 | ## Returns 18 | 19 | `void` \| `Promise`\<`void`\> 20 | 21 | ## Defined in 22 | 23 | [types-dev/index.d.ts:396](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L396) 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/StateValue.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / StateValue 6 | 7 | # Type Alias: StateValue 8 | 9 | > **StateValue**: `string` \| `number` \| `boolean` \| `null` 10 | 11 | ## Defined in 12 | 13 | [types-dev/index.d.ts:58](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L58) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/StringOrTranslated.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / StringOrTranslated 6 | 7 | # Type Alias: StringOrTranslated 8 | 9 | > **StringOrTranslated**: `string` \| [`Translated`](Translated.md) 10 | 11 | For objects, we require the English language to be present 12 | 13 | ## Defined in 14 | 15 | [types-dev/objects.d.ts:162](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L162) 16 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/Timeout.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Timeout 6 | 7 | # Type Alias: Timeout 8 | 9 | > **Timeout**: [`Branded`](Branded.md)\<`number`, `"Timeout"`\> \| `null` 10 | 11 | ## Defined in 12 | 13 | [types-dev/index.d.ts:575](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L575) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/TimeoutCallback.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / TimeoutCallback 6 | 7 | # Type Alias: TimeoutCallback() 8 | 9 | > **TimeoutCallback**: (...`args`) => `void` 10 | 11 | ## Parameters 12 | 13 | • ...**args**: `any`[] 14 | 15 | ## Returns 16 | 17 | `void` 18 | 19 | ## Defined in 20 | 21 | [adapter/src/lib/\_Types.ts:357](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L357) 22 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/Translated.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / Translated 6 | 7 | # Type Alias: Translated 8 | 9 | > **Translated**: `object` & `{ [lang in Languages]?: string }` 10 | 11 | ## Type declaration 12 | 13 | ### en 14 | 15 | > **en**: `string` 16 | 17 | ## Defined in 18 | 19 | [types-dev/objects.d.ts:159](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L159) 20 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/UnloadHandler.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / UnloadHandler 6 | 7 | # Type Alias: UnloadHandler() 8 | 9 | > **UnloadHandler**: (`callback`) => `void` \| `Promise`\<`void`\> 10 | 11 | ## Parameters 12 | 13 | • **callback**: [`EmptyCallback`](EmptyCallback.md) 14 | 15 | ## Returns 16 | 17 | `void` \| `Promise`\<`void`\> 18 | 19 | ## Defined in 20 | 21 | [types-dev/index.d.ts:399](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/index.d.ts#L399) 22 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/User.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / User 6 | 7 | # Type Alias: User 8 | 9 | > **User**: \`system.user.$\{string\}\` 10 | 11 | ## Defined in 12 | 13 | [types-dev/objects.d.ts:87](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L87) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/UserChangeFunction.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / UserChangeFunction 6 | 7 | # Type Alias: UserChangeFunction() 8 | 9 | > **UserChangeFunction**: (`id`, `state`) => `void` 10 | 11 | ## Parameters 12 | 13 | • **id**: `string` 14 | 15 | • **state**: [`State`](../interfaces/State.md) \| `null` 16 | 17 | ## Returns 18 | 19 | `void` 20 | 21 | ## Defined in 22 | 23 | db-states-redis/build/esm/lib/states/statesInRedisClient.d.ts:12 24 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/UserInterfaceClientRemoveMessage.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / UserInterfaceClientRemoveMessage 6 | 7 | # Type Alias: UserInterfaceClientRemoveMessage 8 | 9 | > **UserInterfaceClientRemoveMessage**: `Omit`\<[`Message`](../interfaces/Message.md), `"message"` \| `"command"`\> & `object` \| `Omit`\<[`Message`](../interfaces/Message.md), `"message"` \| `"command"`\> & `object` 10 | 11 | ## Defined in 12 | 13 | [adapter/src/lib/\_Types.ts:180](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L180) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/UserInterfaceClientSubscribeHandler.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / UserInterfaceClientSubscribeHandler 6 | 7 | # Type Alias: UserInterfaceClientSubscribeHandler() 8 | 9 | > **UserInterfaceClientSubscribeHandler**: (`subscribeInfo`) => [`UserInterfaceClientSubscribeReturnType`](../interfaces/UserInterfaceClientSubscribeReturnType.md) \| `Promise`\<[`UserInterfaceClientSubscribeReturnType`](../interfaces/UserInterfaceClientSubscribeReturnType.md)\> 10 | 11 | ## Parameters 12 | 13 | • **subscribeInfo**: [`UserInterfaceSubscribeInfo`](../interfaces/UserInterfaceSubscribeInfo.md) 14 | 15 | ## Returns 16 | 17 | [`UserInterfaceClientSubscribeReturnType`](../interfaces/UserInterfaceClientSubscribeReturnType.md) \| `Promise`\<[`UserInterfaceClientSubscribeReturnType`](../interfaces/UserInterfaceClientSubscribeReturnType.md)\> 18 | 19 | ## Defined in 20 | 21 | [adapter/src/lib/\_Types.ts:143](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L143) 22 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/UserInterfaceClientUnsubscribeHandler.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / UserInterfaceClientUnsubscribeHandler 6 | 7 | # Type Alias: UserInterfaceClientUnsubscribeHandler() 8 | 9 | > **UserInterfaceClientUnsubscribeHandler**: (`unsubscribeInfo`) => `void` \| `Promise`\<`void`\> 10 | 11 | ## Parameters 12 | 13 | • **unsubscribeInfo**: [`UserInterfaceUnsubscribeInfo`](UserInterfaceUnsubscribeInfo.md) 14 | 15 | ## Returns 16 | 17 | `void` \| `Promise`\<`void`\> 18 | 19 | ## Defined in 20 | 21 | [adapter/src/lib/\_Types.ts:176](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L176) 22 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/UserInterfaceClientUnsubscribeReason.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / UserInterfaceClientUnsubscribeReason 6 | 7 | # Type Alias: UserInterfaceClientUnsubscribeReason 8 | 9 | > **UserInterfaceClientUnsubscribeReason**: [`ClientUnsubscribeReason`](ClientUnsubscribeReason.md) \| `"timeout"` 10 | 11 | ## Defined in 12 | 13 | [adapter/src/lib/\_Types.ts:69](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L69) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/UserInterfaceUnsubscribeInfo.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / UserInterfaceUnsubscribeInfo 6 | 7 | # Type Alias: UserInterfaceUnsubscribeInfo 8 | 9 | > **UserInterfaceUnsubscribeInfo**: [`UserInterfaceUnsubscribeInfoBaseObject`](UserInterfaceUnsubscribeInfoBaseObject.md) & `object` \| `object` 10 | 11 | ## Defined in 12 | 13 | [adapter/src/lib/\_Types.ts:161](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L161) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/UserInterfaceUnsubscribeInfoBaseObject.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / UserInterfaceUnsubscribeInfoBaseObject 6 | 7 | # Type Alias: UserInterfaceUnsubscribeInfoBaseObject 8 | 9 | > **UserInterfaceUnsubscribeInfoBaseObject**: `object` 10 | 11 | ## Type declaration 12 | 13 | ### clientId 14 | 15 | > **clientId**: `string` 16 | 17 | The handler id, which can be used to send information to clients 18 | 19 | ## Defined in 20 | 21 | [adapter/src/lib/\_Types.ts:156](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/_Types.ts#L156) 22 | -------------------------------------------------------------------------------- /packages/controller/doc/-internal-/type-aliases/WelcomeScreenEntry.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../../globals.md) / [\](../README.md) / WelcomeScreenEntry 6 | 7 | # Type Alias: WelcomeScreenEntry 8 | 9 | > **WelcomeScreenEntry**: `string` \| `object` 10 | 11 | ## Defined in 12 | 13 | [types-dev/objects.d.ts:476](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/types-dev/objects.d.ts#L476) 14 | -------------------------------------------------------------------------------- /packages/controller/doc/README.md: -------------------------------------------------------------------------------- 1 | **@iobroker/js-controller-adapter** • [**Docs**](globals.md) 2 | 3 | *** 4 | 5 | # Adapter class for ioBroker 6 | The Library contains the Adapter class of ioBroker. 7 | 8 | ## License 9 | MIT 10 | Copyright 2018-2024 bluefox 11 | -------------------------------------------------------------------------------- /packages/controller/doc/globals.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](README.md) • **Docs** 2 | 3 | *** 4 | 5 | # @iobroker/js-controller-adapter 6 | 7 | ## Modules 8 | 9 | - [\](-internal-/README.md) 10 | 11 | ## Classes 12 | 13 | - [AdapterClass](classes/AdapterClass.md) 14 | 15 | ## Variables 16 | 17 | - [Adapter](variables/Adapter.md) 18 | -------------------------------------------------------------------------------- /packages/controller/doc/variables/Adapter.md: -------------------------------------------------------------------------------- 1 | [**@iobroker/js-controller-adapter**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [@iobroker/js-controller-adapter](../globals.md) / Adapter 6 | 7 | # Variable: Adapter 8 | 9 | > `const` **Adapter**: *typeof* [`AdapterClass`](../classes/AdapterClass.md) 10 | 11 | Polyfill to allow calling without `new` 12 | 13 | ## Defined in 14 | 15 | [adapter/src/lib/adapter/adapter.ts:12205](https://github.com/ioBroker/ioBroker.js-controller/blob/ec9b0b016d2d4f5ad1591c6bd149fd060033bed1/packages/adapter/src/lib/adapter/adapter.ts#L12205) 16 | -------------------------------------------------------------------------------- /packages/controller/iobroker.js: -------------------------------------------------------------------------------- 1 | import('@iobroker/js-controller-cli').then(res => res.execute()); 2 | -------------------------------------------------------------------------------- /packages/controller/src/compactgroupController.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * Controller process for Compact Groups 3 | * 4 | * Copyright 2018-2024 bluefox , 5 | * MIT License 6 | * 7 | */ 8 | import { init } from '@/main.js'; 9 | 10 | const compactGroup = parseInt(process.argv[2], 10); 11 | if (isNaN(compactGroup) || compactGroup < 1) { 12 | console.log(`Invalid compact group (${compactGroup}) as first parameter. Exit.`); 13 | process.exit(); 14 | } 15 | 16 | init(compactGroup); 17 | -------------------------------------------------------------------------------- /packages/controller/src/lib/adapter.ts: -------------------------------------------------------------------------------- 1 | // staying backward compatible 2 | import { Adapter } from '@iobroker/js-controller-adapter'; 3 | 4 | export default Adapter; 5 | -------------------------------------------------------------------------------- /packages/controller/src/lib/exitCodes.ts: -------------------------------------------------------------------------------- 1 | // staying backward compatible 2 | import { EXIT_CODES } from '@iobroker/js-controller-common'; 3 | 4 | export default EXIT_CODES; 5 | -------------------------------------------------------------------------------- /packages/controller/src/lib/objects/objectsInMemClient.ts: -------------------------------------------------------------------------------- 1 | // Deprecated. This is only for back compatibility by tests! 2 | console.warn('Deprecated! Please use require("@iobroker/db-objects-redis").Client library in tests!'); 3 | 4 | import { Client } from '@iobroker/db-objects-redis'; 5 | export default Client; 6 | -------------------------------------------------------------------------------- /packages/controller/src/lib/objects/objectsInMemServer.ts: -------------------------------------------------------------------------------- 1 | // Deprecated. This is only for back compatibility by tests! 2 | console.warn( 3 | 'Deprecated! Please use require("@iobroker/db-objects-file").Server in tests to start a server and then use require("@iobroker/db-objects-file").Client to connect with a client against this server!', 4 | ); 5 | 6 | import { Server } from '@iobroker/db-objects-file'; 7 | export default Server; 8 | -------------------------------------------------------------------------------- /packages/controller/src/lib/password.ts: -------------------------------------------------------------------------------- 1 | import { password } from '@iobroker/js-controller-common'; 2 | 3 | export default password; 4 | -------------------------------------------------------------------------------- /packages/controller/src/lib/states/statesInMemClient.ts: -------------------------------------------------------------------------------- 1 | // Deprecated. This is only for back compatibility by tests! 2 | console.warn('Deprecated! Please use require("@iobroker/db-states-redis").Client library in tests!'); 3 | 4 | import { Client } from '@iobroker/db-states-redis'; 5 | 6 | export default Client; 7 | -------------------------------------------------------------------------------- /packages/controller/src/lib/states/statesInMemServer.ts: -------------------------------------------------------------------------------- 1 | // Deprecated. This is only for back compatibility by tests! 2 | console.warn( 3 | 'Deprecated! Please use require("@iobroker/db-states-file").Server in tests to start a server and then use require("@iobroker/db-states-file").Client to connect with a client against this server!', 4 | ); 5 | 6 | import { Server } from '@iobroker/db-states-file'; 7 | export default Server; 8 | -------------------------------------------------------------------------------- /packages/controller/src/lib/tools.ts: -------------------------------------------------------------------------------- 1 | // backward compatibility 2 | import { tools } from '@iobroker/js-controller-common'; 3 | 4 | export default tools; 5 | -------------------------------------------------------------------------------- /packages/controller/src/lib/types.d.ts: -------------------------------------------------------------------------------- 1 | export {}; 2 | 3 | declare global { 4 | namespace NodeJS { 5 | interface ProcessEnv { 6 | /** If set to 'true' no capabilities for the node executable will be set by the controller */ 7 | IOB_NO_SETCAP?: string; 8 | } 9 | } 10 | } 11 | -------------------------------------------------------------------------------- /packages/controller/test/_Types.ts: -------------------------------------------------------------------------------- 1 | /// 2 | import type { AdapterClass } from '@iobroker/js-controller-adapter'; 3 | import type { Client as StatesInRedisClient } from '@iobroker/db-states-redis'; 4 | import type { Client as ObjectsInRedisClient } from '@iobroker/db-objects-redis'; 5 | 6 | export interface TestContext extends Mocha.Context { 7 | /** The adapter instance */ 8 | adapter: AdapterClass; 9 | /** The states DB */ 10 | states: StatesInRedisClient; 11 | /** The objects db */ 12 | objects: ObjectsInRedisClient; 13 | /** Allow to unregister handler by setting null */ 14 | onAdapterStateChanged: ioBroker.StateChangeHandler | null; 15 | /** Allow to unregister handler by setting null */ 16 | onAdapterFileChanged: ioBroker.FileChangeHandler | null; 17 | /** Allow to unregister handler by setting null */ 18 | onAdapterMessage: ioBroker.MessageHandler | null; 19 | /** Allow to unregister handler by setting null */ 20 | onAdapterObjectChanged: ioBroker.ObjectChangeHandler | null; 21 | } 22 | -------------------------------------------------------------------------------- /packages/controller/test/lib/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "iobroker.test", 3 | "type": "module", 4 | "version": "0.1.0", 5 | "description": "Test adapter", 6 | "author": { 7 | "name": "bluefox", 8 | "email": "dogafox@gmail.com" 9 | }, 10 | "homepage": "https://github.com/ioBroker/ioBroker.test", 11 | "readme": "https://github.com/ioBroker/ioBroker.test/blob/master/README.md", 12 | "keywords": [ 13 | "ioBroker", 14 | "calendar", 15 | "test" 16 | ], 17 | "repository": { 18 | "type": "git", 19 | "url": "https://github.com/ioBroker/ioBroker.test" 20 | }, 21 | "dependencies": { 22 | }, 23 | "devDependencies": { 24 | }, 25 | "bugs": { 26 | "url": "https://github.com/ioBroker/ioBroker.test/issues" 27 | }, 28 | "main": "main.js", 29 | "scripts": { 30 | "test": "echo \"Error: no test specified\" && exit 1" 31 | }, 32 | "license": "MIT" 33 | } 34 | -------------------------------------------------------------------------------- /packages/controller/test/lib/permissions.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * Translations from linux file permissions to ioBroker 3 | * Linux is like "owner,user in group,user outside group", 6 = rw; 4 = w; 2 = r 4 | */ 5 | export const PERMISSIONS = { 6 | // Only owner can read/write 7 | '0600': 1536, 8 | // Everyone can read/write 9 | '0666': 1638, 10 | // User outside group can only write 11 | '0664': 1636, 12 | } as const; 13 | -------------------------------------------------------------------------------- /packages/controller/test/lib/testEnums.ts: -------------------------------------------------------------------------------- 1 | export function register(/*it: Mocha.TestFunction, expect: Chai.ExpectStatic, context: TestContext*/): void { 2 | // getEnum 3 | // getEnums 4 | // addChannelToEnum 5 | // deleteChannelFromEnum 6 | // addStateToEnum 7 | // deleteStateFromEnum 8 | } 9 | -------------------------------------------------------------------------------- /packages/controller/test/redis-sentinel/.gitignore: -------------------------------------------------------------------------------- 1 | *.rdb 2 | ./*.config -------------------------------------------------------------------------------- /packages/controller/test/redis-sentinel/config/redis1.config: -------------------------------------------------------------------------------- 1 | port 6380 2 | bind 127.0.0.1 3 | logfile "" 4 | -------------------------------------------------------------------------------- /packages/controller/test/redis-sentinel/config/redis2.config: -------------------------------------------------------------------------------- 1 | port 6381 2 | bind 127.0.0.1 3 | replicaof 127.0.0.1 6380 4 | logfile "" 5 | -------------------------------------------------------------------------------- /packages/controller/test/redis-sentinel/config/redis3.config: -------------------------------------------------------------------------------- 1 | port 6382 2 | bind 127.0.0.1 3 | replicaof 127.0.0.1 6380 4 | logfile "" 5 | -------------------------------------------------------------------------------- /packages/controller/test/redis-sentinel/config/sentinel1.config: -------------------------------------------------------------------------------- 1 | port 26380 2 | sentinel monitor mymaster 127.0.0.1 6380 2 3 | sentinel down-after-milliseconds mymaster 5000 4 | sentinel failover-timeout mymaster 60000 5 | sentinel parallel-syncs mymaster 1 6 | logfile "" -------------------------------------------------------------------------------- /packages/controller/test/redis-sentinel/config/sentinel2.config: -------------------------------------------------------------------------------- 1 | port 26381 2 | sentinel monitor mymaster 127.0.0.1 6380 2 3 | sentinel down-after-milliseconds mymaster 5000 4 | sentinel failover-timeout mymaster 60000 5 | sentinel parallel-syncs mymaster 1 6 | logfile "" -------------------------------------------------------------------------------- /packages/controller/test/redis-sentinel/config/sentinel3.config: -------------------------------------------------------------------------------- 1 | port 26382 2 | sentinel monitor mymaster 127.0.0.1 6380 2 3 | sentinel down-after-milliseconds mymaster 5000 4 | sentinel failover-timeout mymaster 60000 5 | sentinel parallel-syncs mymaster 1 6 | logfile "" -------------------------------------------------------------------------------- /packages/controller/test/redis-sentinel/setup-sentinel-cleanup.sh: -------------------------------------------------------------------------------- 1 | #/bin/sh 2 | set +e 3 | 4 | if [ -z "$TRAVIS_BUILD_DIR" ] 5 | then 6 | TRAVIS_BUILD_DIR="$(pwd)/../.." 7 | fi 8 | rm -f ${TRAVIS_BUILD_DIR}/test/redis-sentinel/dump.rdb 9 | rm -f ${TRAVIS_BUILD_DIR}/test/redis-sentinel/log/*.log 10 | rm -f ${TRAVIS_BUILD_DIR}/test/redis-sentinel/*.config 11 | -------------------------------------------------------------------------------- /packages/controller/test/redis-sentinel/setup-sentinel-stop.sh: -------------------------------------------------------------------------------- 1 | #/bin/sh 2 | set +e 3 | redis-cli -p 26382 SHUTDOWN || true 4 | redis-cli -p 26381 SHUTDOWN || true 5 | redis-cli -p 26380 SHUTDOWN || true 6 | redis-cli -p 6382 SHUTDOWN || true 7 | redis-cli -p 6381 SHUTDOWN || true 8 | redis-cli -p 6380 SHUTDOWN || true 9 | -------------------------------------------------------------------------------- /packages/controller/test/redis-sentinel/test-sentinel.sh: -------------------------------------------------------------------------------- 1 | #/bin/sh 2 | ./setup-sentinel-start.sh 3 | npm run test-redis-sentinel 4 | ./setup-sentinel-stop.sh 5 | -------------------------------------------------------------------------------- /packages/controller/test/redis-sentinel/testAdapterStatesRedis.ts: -------------------------------------------------------------------------------- 1 | import testAdapter from './../lib/testAdapter.js'; 2 | import fs from 'node:fs'; 3 | 4 | import * as url from 'node:url'; 5 | // eslint-disable-next-line unicorn/prefer-module 6 | const thisDir = url.fileURLToPath(new URL('.', import.meta.url || `file://${__filename}`)); 7 | 8 | const dataDir = `${thisDir}/../../tmp/data-redis`; 9 | 10 | const statesConfig = { 11 | options: { 12 | auth_pass: null, 13 | retry_max_delay: 15000, 14 | }, 15 | type: 'redis', 16 | redisNamespace: 'testObjectsIo', 17 | host: ['127.0.0.1', '127.0.0.1', '127.0.0.1'], 18 | port: [26380, 26381, 26382], 19 | }; 20 | 21 | if (!fs.existsSync(`${thisDir}/../tmp`)) { 22 | fs.mkdirSync(`${thisDir}/../tmp`); 23 | } 24 | 25 | const objectsConfig = { 26 | dataDir: dataDir, 27 | type: 'file', 28 | host: '127.0.0.1', 29 | port: 19002, 30 | user: '', 31 | pass: '', 32 | noFileCache: true, 33 | connectTimeout: 2000, 34 | }; 35 | 36 | // states in REDIS, objects in files 37 | testAdapter({ 38 | statesConfig: statesConfig, 39 | objectsConfig: objectsConfig, 40 | name: 'Tests Redis-Sentinel', 41 | }); 42 | -------------------------------------------------------------------------------- /packages/controller/test/redis-socket/redis-socket.config: -------------------------------------------------------------------------------- 1 | # Specify the path for the unix socket that will be used to listen for 2 | # incoming connections. There is no default, so Redis will not listen 3 | # on a unix socket when not specified. 4 | # 5 | port 0 6 | bind 127.0.0.1 7 | unixsocket /var/run/redis.sock 8 | unixsocketperm 777 9 | 10 | # The default values of all other parameters should be ok. 11 | -------------------------------------------------------------------------------- /packages/controller/test/redis-socket/setup-socket.sh: -------------------------------------------------------------------------------- 1 | #/bin/sh 2 | redis-cli SHUTDOWN 3 | sudo redis-server packages/controller/test/redis-socket/redis-socket.config & 4 | sleep 15 5 | redis-cli -s /var/run/redis.sock PING 6 | npm run test-redis-socket 7 | redis-cli -s /var/run/redis.sock PING 8 | redis-cli -s /var/run/redis.sock SHUTDOWN 9 | -------------------------------------------------------------------------------- /packages/controller/test/redis-socket/testAdapterStatesRedis.ts: -------------------------------------------------------------------------------- 1 | import * as url from 'node:url'; 2 | // eslint-disable-next-line unicorn/prefer-module 3 | const thisDir = url.fileURLToPath(new URL('.', import.meta.url || `file://${__filename}`)); 4 | 5 | import testAdapter from './../lib/testAdapter.js'; 6 | const dataDir = `${thisDir}/../../tmp/data-redis`; 7 | import fs from 'node:fs'; 8 | 9 | const statesConfig = { 10 | options: { 11 | auth_pass: null, 12 | retry_max_delay: 15000, 13 | }, 14 | type: 'redis', 15 | redisNamespace: 'testObjectsIo', 16 | host: '/var/run/redis.sock', 17 | port: 0, 18 | }; 19 | 20 | if (!fs.existsSync(`${thisDir}/../tmp`)) { 21 | fs.mkdirSync(`${thisDir}/../tmp`); 22 | } 23 | 24 | const objectsConfig = { 25 | dataDir: dataDir, 26 | type: 'file', 27 | host: '127.0.0.1', 28 | port: 19002, 29 | user: '', 30 | pass: '', 31 | noFileCache: true, 32 | connectTimeout: 2000, 33 | }; 34 | 35 | // states in REDIS, objects in files 36 | testAdapter({ 37 | statesConfig: statesConfig, 38 | objectsConfig: objectsConfig, 39 | name: 'Tests REDIS-Socket', 40 | }); 41 | -------------------------------------------------------------------------------- /packages/controller/test/testAdapterStatesInFile.ts: -------------------------------------------------------------------------------- 1 | import path from 'node:path'; 2 | import * as url from 'node:url'; 3 | // eslint-disable-next-line unicorn/prefer-module 4 | const thisDir = url.fileURLToPath(new URL('.', import.meta.url || `file://${__filename}`)); 5 | import testAdapter from './lib/testAdapter.js'; 6 | const dataDir = path.join(thisDir, '..', 'tmp', 'data'); 7 | 8 | const statesConfig = { 9 | options: { 10 | auth_pass: null, 11 | retry_max_delay: 100, 12 | retry_max_count: 2, 13 | }, 14 | type: 'file', 15 | host: '127.0.0.1', 16 | port: 19000, 17 | user: '', 18 | pass: '', 19 | dataDir: dataDir, 20 | }; 21 | 22 | const objectsConfig = { 23 | options: { 24 | auth_pass: null, 25 | retry_max_delay: 100, 26 | retry_max_count: 2, 27 | }, 28 | dataDir: dataDir, 29 | type: 'file', 30 | host: '127.0.0.1', 31 | port: 19001, 32 | user: '', 33 | pass: '', 34 | noFileCache: true, 35 | connectTimeout: 2000, 36 | }; 37 | 38 | // states in files, objects in files 39 | testAdapter({ 40 | statesConfig, 41 | objectsConfig, 42 | name: 'Tests FILE', 43 | }); 44 | -------------------------------------------------------------------------------- /packages/controller/test/testAdapterStatesRedis.ts: -------------------------------------------------------------------------------- 1 | import testAdapter from './lib/testAdapter.js'; 2 | import * as url from 'node:url'; 3 | // eslint-disable-next-line unicorn/prefer-module 4 | const thisDir = url.fileURLToPath(new URL('.', import.meta.url || `file://${__filename}`)); 5 | 6 | const statesConfig = { 7 | options: { 8 | auth_pass: null, 9 | retry_max_delay: 100, 10 | retry_max_count: 2, 11 | }, 12 | type: 'redis', 13 | host: '127.0.0.1', 14 | port: 6379, 15 | }; 16 | 17 | const objectsConfig = { 18 | dataDir: `${thisDir}/../tmp/data`, 19 | options: { 20 | auth_pass: null, 21 | retry_max_delay: 100, 22 | }, 23 | redisNamespace: 'test', 24 | type: 'redis', 25 | host: '127.0.0.1', 26 | port: 6379, 27 | }; 28 | 29 | // states in REDIS, objects in files 30 | testAdapter({ 31 | statesConfig, 32 | objectsConfig, 33 | name: 'Tests REDIS', 34 | }); 35 | -------------------------------------------------------------------------------- /packages/controller/tsconfig.check.json: -------------------------------------------------------------------------------- 1 | // specialized config for type checking (test folder included) 2 | { 3 | "extends": "./tsconfig.json", 4 | } -------------------------------------------------------------------------------- /packages/controller/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json", 3 | "compilerOptions": { 4 | "outDir": "build/esm", 5 | "module": "NodeNext", 6 | "paths": { 7 | "@/*": [ 8 | "./src/*" 9 | ] 10 | } 11 | }, 12 | "references": [ 13 | { 14 | "path": "../db-objects-file/tsconfig.json" 15 | }, 16 | { 17 | "path": "../db-objects-jsonl/tsconfig.json" 18 | }, 19 | { 20 | "path": "../db-objects-redis/tsconfig.json" 21 | }, 22 | { 23 | "path": "../db-states-file/tsconfig.json" 24 | }, 25 | { 26 | "path": "../db-states-jsonl/tsconfig.json" 27 | }, 28 | { 29 | "path": "../db-states-redis/tsconfig.json" 30 | }, 31 | { 32 | "path": "../adapter/tsconfig.json" 33 | }, 34 | { 35 | "path": "../cli/tsconfig.json" 36 | }, 37 | { 38 | "path": "../common/tsconfig.json" 39 | }, 40 | { 41 | "path": "../common-db/tsconfig.json" 42 | } 43 | ], 44 | "include": [ 45 | "test/**/*.ts", 46 | "src/**/*.ts", 47 | "src/**/*.js" 48 | ], 49 | "exclude": [ 50 | "build/**", 51 | "node_modules/**" 52 | ] 53 | } -------------------------------------------------------------------------------- /packages/db-base/README.md: -------------------------------------------------------------------------------- 1 | # Base DB classes for ioBroker 2 | This Library contains base classes that are used by the database classes for ioBroker 3 | 4 | ## License 5 | The MIT License (MIT) 6 | 7 | Copyright (c) 2014-2024 bluefox , 8 | Copyright (c) 2014 hobbyquaker 9 | -------------------------------------------------------------------------------- /packages/db-base/src/index.ts: -------------------------------------------------------------------------------- 1 | export { InMemoryFileDB } from './lib/inMemFileDB.js'; 2 | export { RedisHandler } from './lib/redisHandler.js'; 3 | export { tools } from '@iobroker/js-controller-common-db'; 4 | -------------------------------------------------------------------------------- /packages/db-base/src/lib/constants.ts: -------------------------------------------------------------------------------- 1 | // @ts-expect-error types missing 2 | import Resp from 'respjs'; 3 | 4 | export const QUEUED_STR_BUF: Buffer = Resp.encodeString('QUEUED'); 5 | export const OK_STR_BUF: Buffer = Resp.encodeString('OK'); 6 | -------------------------------------------------------------------------------- /packages/db-base/tsconfig.build.json: -------------------------------------------------------------------------------- 1 | // Specialized tsconfig to only compile .ts-files in the src dir 2 | { 3 | "extends": "./tsconfig.json", 4 | "compilerOptions": { 5 | "allowJs": false, 6 | "checkJs": false, 7 | "noEmit": false 8 | }, 9 | "references": [ 10 | { 11 | "path": "../common-db/tsconfig.build.json" 12 | }, 13 | ], 14 | "include": [ 15 | "src/**/*.ts", 16 | "src/**/*.js" // currently, we have js too 17 | ], 18 | "exclude": [ 19 | "src/**/*.test.ts", 20 | "build/**", 21 | "node_modules/**" 22 | ] 23 | } -------------------------------------------------------------------------------- /packages/db-base/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json", 3 | "compilerOptions": { 4 | "outDir": "build/esm", 5 | "rootDir": "src", 6 | "module": "NodeNext" 7 | }, 8 | "references": [ 9 | { 10 | "path": "../common-db/tsconfig.json" 11 | }, 12 | ], 13 | "include": [ 14 | "src/**/*.ts" 15 | ], 16 | "exclude": [ 17 | "build/**", 18 | "node_modules/**" 19 | ] 20 | } -------------------------------------------------------------------------------- /packages/db-objects-file/src/index.ts: -------------------------------------------------------------------------------- 1 | export { ObjectsInMemoryFileDB } from './lib/objects/objectsInMemFileDB.js'; 2 | export { Client } from '@iobroker/db-objects-redis'; 3 | export { ObjectsInMemoryServerClass as Server } from './lib/objects/objectsInMemServerClass.js'; 4 | 5 | /** 6 | * Get the default port of the objects db 7 | */ 8 | export function getDefaultPort(): number { 9 | return 9001; 10 | } 11 | -------------------------------------------------------------------------------- /packages/db-objects-file/tsconfig.build.json: -------------------------------------------------------------------------------- 1 | // Specialized tsconfig to only compile .ts-files in the src dir 2 | { 3 | "extends": "./tsconfig.json", 4 | "compilerOptions": { 5 | "allowJs": true, 6 | "checkJs": false, 7 | "noEmit": false 8 | }, 9 | "references": [ 10 | { 11 | "path": "../db-base/tsconfig.build.json" 12 | }, 13 | { 14 | "path": "../db-objects-redis/tsconfig.build.json" 15 | }, 16 | ], 17 | "include": [ 18 | "src/**/*.ts", 19 | "src/**/*.js" // currently, we have js too 20 | ], 21 | "exclude": [ 22 | "src/**/*.test.ts", 23 | "build/**", 24 | "node_modules/**" 25 | ] 26 | } -------------------------------------------------------------------------------- /packages/db-objects-file/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json", 3 | "compilerOptions": { 4 | "outDir": "build/esm", 5 | "rootDir": "src", 6 | "noEmit": false, 7 | "module": "NodeNext" 8 | }, 9 | "references": [ 10 | { 11 | "path": "../db-base/tsconfig.json" 12 | }, 13 | { 14 | "path": "../db-objects-redis/tsconfig.json" 15 | } 16 | ], 17 | "include": [ 18 | "src/**/*.ts", 19 | "src/**/*.js" 20 | ], 21 | "exclude": [ 22 | "build/**", 23 | "node_modules/**" 24 | ] 25 | } -------------------------------------------------------------------------------- /packages/db-objects-jsonl/README.md: -------------------------------------------------------------------------------- 1 | # File DB JSONL objects classes for ioBroker 2 | The Library contains the JSONL Database classes for File based objects database client and server. 3 | 4 | ## License 5 | The MIT License (MIT) 6 | 7 | Copyright 2018-2024 bluefox 8 | -------------------------------------------------------------------------------- /packages/db-objects-jsonl/src/index.ts: -------------------------------------------------------------------------------- 1 | export { Client } from '@iobroker/db-objects-redis'; 2 | export { ObjectsInMemoryServerClass as Server } from './lib/objects/objectsInMemServerClass.js'; 3 | 4 | /** 5 | * Get the default port of the objects db 6 | */ 7 | export function getDefaultPort(): number { 8 | return 9001; 9 | } 10 | -------------------------------------------------------------------------------- /packages/db-objects-jsonl/tsconfig.build.json: -------------------------------------------------------------------------------- 1 | // Specialized tsconfig to only compile .ts-files in the src dir 2 | { 3 | "extends": "./tsconfig.json", 4 | "compilerOptions": { 5 | "allowJs": true, 6 | "checkJs": false, 7 | "noEmit": false 8 | }, 9 | "references": [ 10 | { 11 | "path": "../db-base/tsconfig.build.json" 12 | }, 13 | { 14 | "path": "../db-objects-file/tsconfig.build.json" 15 | }, 16 | { 17 | "path": "../db-objects-redis/tsconfig.build.json" 18 | }, 19 | ], 20 | "include": [ 21 | "src/**/*.ts", 22 | "src/**/*.js" // currently, we have js too 23 | ], 24 | "exclude": [ 25 | "src/**/*.test.ts", 26 | "build/**", 27 | "node_modules/**" 28 | ] 29 | } -------------------------------------------------------------------------------- /packages/db-objects-jsonl/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json", 3 | "compilerOptions": { 4 | "outDir": "build/esm", 5 | "module": "NodeNext", 6 | "rootDir": "src", 7 | "noEmit": false 8 | }, 9 | "references": [ 10 | { 11 | "path": "../db-base/tsconfig.json" 12 | }, 13 | { 14 | "path": "../db-objects-file/tsconfig.json" 15 | }, 16 | { 17 | "path": "../db-objects-redis/tsconfig.json" 18 | } 19 | ], 20 | "include": [ 21 | "src/**/*.ts", 22 | "src/**/*.js" 23 | ], 24 | "exclude": [ 25 | "build/**", 26 | "node_modules/**" 27 | ] 28 | } -------------------------------------------------------------------------------- /packages/db-objects-redis/README.md: -------------------------------------------------------------------------------- 1 | # Redis objects DB classes for ioBroker 2 | The Library contains the Database classes for Redis based objects database client. 3 | 4 | ## License 5 | Apache 2.0 6 | Copyright 2018-2024 bluefox 7 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/index.ts: -------------------------------------------------------------------------------- 1 | /// 2 | /** 3 | * Get the default port for the database 4 | * 5 | * @param host string of host(s) 6 | */ 7 | export function getDefaultPort(host: string): number { 8 | return host.includes(',') ? 26379 : 6379; 9 | } 10 | export const Server = null; 11 | export { ObjectsInRedisClient as Client } from '@/lib/objects/objectsInRedisClient.js'; 12 | export { interview } from '@/lib/objects/interview.js'; 13 | export * as objectsUtils from '@/lib/objects/objectsUtils.js'; 14 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/lib/objects/interview.ts: -------------------------------------------------------------------------------- 1 | import { defaultRedisInterview } from '@iobroker/js-controller-common-db'; 2 | 3 | /** 4 | * Custom interview during setup 5 | * 6 | * @param config the prefilled database config 7 | * @returns the database options obtained by the answered questionnaire 8 | */ 9 | export function interview(config: ioBroker.ObjectsDatabaseOptions): Promise { 10 | return defaultRedisInterview({ config, type: 'objects' }); 11 | } 12 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/lib/objects/lua-v3/custom.lua: -------------------------------------------------------------------------------- 1 | -- design: system 2 | -- search: custom 3 | local rep = {} 4 | -- local keys=redis.call("keys", KEYS[1].."*") 5 | local cursor = KEYS[4]; 6 | local result = redis.call("SCAN", cursor, "MATCH", KEYS[1] .. "*", "COUNT", 500) 7 | cursor = result[1] 8 | local keys = result[2] 9 | local argStart = KEYS[1] .. KEYS[2] 10 | local argEnd = KEYS[1] .. KEYS[3] 11 | local checkStr = string.format("%q:{", "custom") 12 | -- function(doc) { 13 | -- if (doc.type==="state" && (doc.common.custom || doc.common.history)) 14 | -- emit(doc._id, doc.common.custom || doc.common.history) 15 | -- } 16 | for _, key in ipairs(keys) do 17 | if (key >= argStart and key < argEnd) then 18 | local obj = redis.call("get", key) 19 | if (obj:find(checkStr) ~= nil) then 20 | local success, decoded = pcall(cjson.decode, obj) 21 | if (success and decoded.type == "state" and decoded.common ~= nil and decoded.common.custom ~= nil) then 22 | rep[#rep + 1] = obj 23 | end 24 | end 25 | end 26 | end 27 | return { rep, cursor } 28 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/lib/objects/lua-v3/filter.lua: -------------------------------------------------------------------------------- 1 | -- func: function(doc) { if (doc.type === "%1") emit(doc._id, doc); } 2 | local rep = {} 3 | -- local keys=redis.call("keys", KEYS[1].."*") 4 | local cursor = KEYS[5]; 5 | local result = redis.call("SCAN", cursor, "MATCH", KEYS[1] .. "*", "COUNT", 500) 6 | cursor = result[1] 7 | local keys = result[2] 8 | local argStart = KEYS[1] .. KEYS[2] 9 | local argEnd = KEYS[1] .. KEYS[3] 10 | local type = KEYS[4] 11 | local checkStr = string.format("%q:%q", "type", type) 12 | local skipCheck = not (type == "channel" or type == "device" or type == "folder") 13 | -- function(doc) { if (doc.type === "chart") emit(doc._id, doc); } 14 | for _, key in ipairs(keys) do 15 | if (key >= argStart and key < argEnd) then 16 | local obj = redis.call("get", key) 17 | if (skipCheck or obj:find(checkStr) ~= nil) then 18 | local success, decoded = pcall(cjson.decode, obj) 19 | if (success and decoded.type == type) then 20 | rep[#rep + 1] = obj 21 | end 22 | end 23 | end 24 | end 25 | return { rep, cursor } 26 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/lib/objects/lua-v3/programs.lua: -------------------------------------------------------------------------------- 1 | -- design: hm-rega 2 | -- search: programs 3 | local rep = {} 4 | local cursor = KEYS[4]; 5 | local result = redis.call("SCAN", cursor, "MATCH", KEYS[1] .. "*", "COUNT", 500) 6 | cursor = result[1] 7 | local keys = result[2] 8 | local argStart = KEYS[1] .. KEYS[2] 9 | local argEnd = KEYS[1] .. KEYS[3] 10 | local checkStr = string.format("%q:%q", "TypeName", "PROGRAM") 11 | -- function(doc) { 12 | -- if (doc._id.match(/^hm-rega\\.[0-9]+\\.[0-9,A-Z,a-z]+/) && (doc.native.TypeName === "PROGRAM")) { 13 | -- emit(doc._id, doc); 14 | -- } 15 | -- } 16 | for _, key in ipairs(keys) do 17 | if (key >= argStart and key < argEnd and key:sub(7, 13) == "hm-rega") then 18 | local obj = redis.call("get", key) 19 | if (obj:find(checkStr) ~= nil) then 20 | local success, decoded = pcall(cjson.decode, obj) 21 | if (success and decoded.native ~= nil and decoded.native.TypeName == "PROGRAM") then 22 | rep[#rep + 1] = obj 23 | end 24 | end 25 | end 26 | end 27 | return { rep, cursor } 28 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/lib/objects/lua-v3/script.lua: -------------------------------------------------------------------------------- 1 | -- design: script 2 | -- search: javascript 3 | local rep = {} 4 | local cursor = KEYS[4]; 5 | local result = redis.call("SCAN", cursor, "MATCH", KEYS[1] .. "*", "COUNT", 500) 6 | cursor = result[1] 7 | local keys = result[2] 8 | local argStart = KEYS[1] .. KEYS[2] 9 | local argEnd = KEYS[1] .. KEYS[3] 10 | local checkStr = string.format("%q:%q", "type", "script") 11 | -- function(doc) { 12 | -- if (doc.type === "script" && doc.common.engineType.match(/^[jJ]ava[sS]cript|^[cC]offee[sS]cript|^[tT]ype[sS]cript|^Blockly/)) emit(doc.common.name, doc); } 13 | for _, key in ipairs(keys) do 14 | if (key >= argStart and key < argEnd) then 15 | local obj = redis.call("get", key) 16 | if (obj:find(checkStr) ~= nil) then 17 | local success, decoded = pcall(cjson.decode, obj) 18 | if (success and decoded.type == "script") then 19 | rep[#rep + 1] = obj 20 | end 21 | end 22 | end 23 | end 24 | return { rep, cursor } 25 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/lib/objects/lua-v4-no-sets/custom.lua: -------------------------------------------------------------------------------- 1 | -- design: system 2 | -- search: custom 3 | local rep = {} 4 | -- local keys=redis.call("keys", KEYS[1].."*") 5 | local cursor = KEYS[4]; 6 | local result = redis.call("SCAN", cursor, "MATCH", KEYS[1] .. "*", "COUNT", 500) 7 | cursor = result[1] 8 | local keys = result[2] 9 | local argStart = KEYS[1] .. KEYS[2] 10 | local argEnd = KEYS[1] .. KEYS[3] 11 | local checkStr = string.format("%q:{", "custom") 12 | -- function(doc) { 13 | -- if (doc.type==="state" && (doc.common.custom || doc.common.history)) 14 | -- emit(doc._id, doc.common.custom || doc.common.history) 15 | -- } 16 | for _, key in ipairs(keys) do 17 | if (key >= argStart and key < argEnd) then 18 | local obj = redis.call("get", key) 19 | if (obj:find(checkStr) ~= nil) then 20 | local success, decoded = pcall(cjson.decode, obj) 21 | if (success and decoded.type == "state" and decoded.common ~= nil and decoded.common.custom ~= nil) then 22 | rep[#rep + 1] = obj 23 | end 24 | end 25 | end 26 | end 27 | return { rep, cursor } 28 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/lib/objects/lua-v4-no-sets/filter.lua: -------------------------------------------------------------------------------- 1 | -- func: function(doc) { if (doc.type === "%1") emit(doc._id, doc); } 2 | local rep = {} 3 | -- local keys=redis.call("keys", KEYS[1].."*") 4 | local cursor = KEYS[5]; 5 | local result = redis.call("SCAN", cursor, "MATCH", KEYS[1] .. "*", "COUNT", 500) 6 | cursor = result[1] 7 | local keys = result[2] 8 | local argStart = KEYS[1] .. KEYS[2] 9 | local argEnd = KEYS[1] .. KEYS[3] 10 | local type = KEYS[4] 11 | local checkStr = string.format("%q:%q", "type", type) 12 | local skipCheck = not (type == "channel" or type == "device" or type == "folder") 13 | -- function(doc) { if (doc.type === "chart") emit(doc._id, doc); } 14 | for _, key in ipairs(keys) do 15 | if (key >= argStart and key < argEnd) then 16 | local obj = redis.call("get", key) 17 | if (skipCheck or obj:find(checkStr) ~= nil) then 18 | local success, decoded = pcall(cjson.decode, obj) 19 | if (success and decoded.type == type) then 20 | rep[#rep + 1] = obj 21 | end 22 | end 23 | end 24 | end 25 | return { rep, cursor } 26 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/lib/objects/lua-v4-no-sets/programs.lua: -------------------------------------------------------------------------------- 1 | -- design: hm-rega 2 | -- search: programs 3 | local rep = {} 4 | local cursor = KEYS[4]; 5 | local result = redis.call("SCAN", cursor, "MATCH", KEYS[1] .. "*", "COUNT", 500) 6 | cursor = result[1] 7 | local keys = result[2] 8 | local argStart = KEYS[1] .. KEYS[2] 9 | local argEnd = KEYS[1] .. KEYS[3] 10 | local checkStr = string.format("%q:%q", "TypeName", "PROGRAM") 11 | -- function(doc) { 12 | -- if (doc._id.match(/^hm-rega\\.[0-9]+\\.[0-9,A-Z,a-z]+/) && (doc.native.TypeName === "PROGRAM")) { 13 | -- emit(doc._id, doc); 14 | -- } 15 | -- } 16 | for _, key in ipairs(keys) do 17 | if (key >= argStart and key < argEnd and key:sub(7, 13) == "hm-rega") then 18 | local obj = redis.call("get", key) 19 | if (obj:find(checkStr) ~= nil) then 20 | local success, decoded = pcall(cjson.decode, obj) 21 | if (success and decoded.native ~= nil and decoded.native.TypeName == "PROGRAM") then 22 | rep[#rep + 1] = obj 23 | end 24 | end 25 | end 26 | end 27 | return { rep, cursor } 28 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/lib/objects/lua-v4-no-sets/redlock_acquire.lua: -------------------------------------------------------------------------------- 1 | -- REDLOCK SCRIPT 2 | -- call with key, value, ms (for set px) 3 | local key = KEYS[1] 4 | 5 | if redis.call("exists", key) == 1 then 6 | -- lock already acquired by someone could be us too (we can only extend) 7 | return 0 8 | end 9 | 10 | redis.call("set", key, KEYS[2], "PX", KEYS[3]) 11 | -- return 1 if lock acquired 12 | return 1 13 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/lib/objects/lua-v4-no-sets/redlock_extend.lua: -------------------------------------------------------------------------------- 1 | -- REDLOCK SCRIPT 2 | -- call with key, value, ms (for set px) 3 | local key = KEYS[1] 4 | 5 | if redis.call("get", key) ~= KEYS[2] then 6 | -- we return 0 if lock is already taken by someone else 7 | return 0 8 | end 9 | 10 | redis.call("set", key, KEYS[2], "PX", KEYS[3]) 11 | -- return 1 if we extended the lock successfully 12 | return 1 13 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/lib/objects/lua-v4-no-sets/redlock_release.lua: -------------------------------------------------------------------------------- 1 | -- REDLOCK SCRIPT 2 | -- release a lock by deleting the key 3 | -- call with key, value 4 | local key = KEYS[1] 5 | 6 | if redis.call("get", key) == KEYS[2] then 7 | redis.pcall("del", key) 8 | -- we need to publish a expire, because redis won't do it 9 | redis.call("publish", "__keyevent@" .. KEYS[3] .. "__:expired", KEYS[4]) 10 | end 11 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/lib/objects/lua-v4-no-sets/script.lua: -------------------------------------------------------------------------------- 1 | -- design: script 2 | -- search: javascript 3 | local rep = {} 4 | local cursor = KEYS[4]; 5 | local result = redis.call("SCAN", cursor, "MATCH", KEYS[1] .. "*", "COUNT", 500) 6 | cursor = result[1] 7 | local keys = result[2] 8 | local argStart = KEYS[1] .. KEYS[2] 9 | local argEnd = KEYS[1] .. KEYS[3] 10 | local checkStr = string.format("%q:%q", "type", "script") 11 | -- function(doc) { 12 | -- if (doc.type === "script" && doc.common.engineType.match(/^[jJ]ava[sS]cript|^[cC]offee[sS]cript|^[tT]ype[sS]cript|^Blockly/)) emit(doc.common.name, doc); } 13 | for _, key in ipairs(keys) do 14 | if (key >= argStart and key < argEnd) then 15 | local obj = redis.call("get", key) 16 | if (obj:find(checkStr) ~= nil) then 17 | local success, decoded = pcall(cjson.decode, obj) 18 | if (success and decoded.type == "script") then 19 | rep[#rep + 1] = obj 20 | end 21 | end 22 | end 23 | end 24 | return { rep, cursor } 25 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/lib/objects/lua-v4/custom.lua: -------------------------------------------------------------------------------- 1 | -- design: system 2 | -- search: custom 3 | local rep = {} 4 | -- local keys=redis.call("keys", KEYS[1].."*") 5 | local cursor = KEYS[4]; 6 | local result = redis.call("SSCAN", KEYS[5], cursor, "MATCH", KEYS[1] .. "*", "COUNT", 500) 7 | cursor = result[1] 8 | local keys = result[2] 9 | local argStart = KEYS[1] .. KEYS[2] 10 | local argEnd = KEYS[1] .. KEYS[3] 11 | -- function(doc) { 12 | -- if (doc.type==="state" && (doc.common.custom || doc.common.history)) 13 | -- emit(doc._id, doc.common.custom || doc.common.history) 14 | -- } 15 | for _, key in ipairs(keys) do 16 | if (key >= argStart and key < argEnd) then 17 | rep[#rep + 1] = redis.call("get", key) 18 | end 19 | end 20 | return { rep, cursor } 21 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/lib/objects/lua-v4/filter.lua: -------------------------------------------------------------------------------- 1 | -- func: function(doc) { if (doc.type === "%1") emit(doc._id, doc); } 2 | local rep = {} 3 | -- local keys=redis.call("keys", KEYS[1].."*") 4 | local cursor = KEYS[5]; 5 | local result = redis.call("SSCAN", KEYS[6], cursor, "MATCH", KEYS[1] .. "*", "COUNT", 500) 6 | cursor = result[1] 7 | local keys = result[2] 8 | local argStart = KEYS[1] .. KEYS[2] 9 | local argEnd = KEYS[1] .. KEYS[3] 10 | -- function(doc) { if (doc.type === "chart") emit(doc._id, doc); } 11 | for _, key in ipairs(keys) do 12 | if (key >= argStart and key < argEnd) then 13 | rep[#rep + 1] = redis.call("get", key) 14 | end 15 | end 16 | return { rep, cursor } 17 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/lib/objects/lua-v4/programs.lua: -------------------------------------------------------------------------------- 1 | -- design: hm-rega 2 | -- search: programs 3 | local rep = {} 4 | local cursor = KEYS[4]; 5 | local result = redis.call("SSCAN", KEYS[5], cursor, "MATCH", KEYS[1] .. "*", "COUNT", 500) 6 | cursor = result[1] 7 | local keys = result[2] 8 | local argStart = KEYS[1] .. KEYS[2] 9 | local argEnd = KEYS[1] .. KEYS[3] 10 | local checkStr = string.format("%q:%q", "TypeName", "PROGRAM") 11 | -- function(doc) { 12 | -- if (doc._id.match(/^hm-rega\\.[0-9]+\\.[0-9,A-Z,a-z]+/) && (doc.native.TypeName === "PROGRAM")) { 13 | -- emit(doc._id, doc); 14 | -- } 15 | -- } 16 | for _, key in ipairs(keys) do 17 | if (key >= argStart and key < argEnd) then 18 | local obj = redis.call("get", key) 19 | if (obj:find(checkStr) ~= nil) then 20 | local success, decoded = pcall(cjson.decode, obj) 21 | if (success and decoded.native ~= nil and decoded.native.TypeName == "PROGRAM") then 22 | rep[#rep + 1] = obj 23 | end 24 | end 25 | end 26 | end 27 | return { rep, cursor } 28 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/lib/objects/lua-v4/redlock_acquire.lua: -------------------------------------------------------------------------------- 1 | -- REDLOCK SCRIPT 2 | -- call with key, value, ms (for set px) 3 | local key = KEYS[1] 4 | 5 | if redis.call("exists", key) == 1 then 6 | -- lock already acquired by someone could be us too (we can only extend) 7 | return 0 8 | end 9 | 10 | redis.call("set", key, KEYS[2], "PX", KEYS[3]) 11 | -- return 1 if lock acquired 12 | return 1 13 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/lib/objects/lua-v4/redlock_extend.lua: -------------------------------------------------------------------------------- 1 | -- REDLOCK SCRIPT 2 | -- call with key, value, ms (for set px) 3 | local key = KEYS[1] 4 | 5 | if redis.call("get", key) ~= KEYS[2] then 6 | -- we return 0 if lock is already taken by someone else 7 | return 0 8 | end 9 | 10 | redis.call("set", key, KEYS[2], "PX", KEYS[3]) 11 | -- return 1 if we extended the lock successfully 12 | return 1 13 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/lib/objects/lua-v4/redlock_release.lua: -------------------------------------------------------------------------------- 1 | -- REDLOCK SCRIPT 2 | -- release a lock by deleting the key 3 | -- call with key, value 4 | local key = KEYS[1] 5 | 6 | if redis.call("get", key) == KEYS[2] then 7 | redis.pcall("del", key) 8 | -- we need to publish a expire, because redis won't do it 9 | redis.call("publish", "__keyevent@" .. KEYS[3] .. "__:expired", KEYS[4]) 10 | end 11 | -------------------------------------------------------------------------------- /packages/db-objects-redis/src/lib/objects/lua-v4/script.lua: -------------------------------------------------------------------------------- 1 | -- design: script 2 | -- search: javascript 3 | local rep = {} 4 | local cursor = KEYS[4]; 5 | local result = redis.call("SSCAN", KEYS[5], cursor, "MATCH", KEYS[1] .. "*", "COUNT", 500) 6 | cursor = result[1] 7 | local keys = result[2] 8 | local argStart = KEYS[1] .. KEYS[2] 9 | local argEnd = KEYS[1] .. KEYS[3] 10 | -- function(doc) { 11 | -- if (doc.type === "script" && doc.common.engineType.match(/^[jJ]ava[sS]cript|^[cC]offee[sS]cript|^[tT]ype[sS]cript|^Blockly/)) emit(doc.common.name, doc); } 12 | for _, key in ipairs(keys) do 13 | if (key >= argStart and key < argEnd) then 14 | rep[#rep + 1] = redis.call("get", key) 15 | end 16 | end 17 | return { rep, cursor } 18 | -------------------------------------------------------------------------------- /packages/db-objects-redis/tsconfig.build.json: -------------------------------------------------------------------------------- 1 | // Specialized tsconfig to only compile .ts-files in the src dir 2 | { 3 | "extends": "./tsconfig.json", 4 | "compilerOptions": { 5 | "allowJs": true, 6 | "checkJs": false, 7 | "noEmit": false 8 | }, 9 | "references": [ 10 | { 11 | "path": "../db-base/tsconfig.build.json" 12 | }, 13 | ], 14 | "include": [ 15 | "src/**/*.ts", 16 | "src/**/*.js" // currently, we have js too 17 | ], 18 | "exclude": [ 19 | "src/**/*.test.ts", 20 | "build/**", 21 | "node_modules/**" 22 | ] 23 | } -------------------------------------------------------------------------------- /packages/db-objects-redis/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json", 3 | "compilerOptions": { 4 | "outDir": "build/esm", 5 | "module": "NodeNext", 6 | "rootDir": "src", 7 | "paths": { 8 | "@/*": [ 9 | "./src/*" 10 | ] 11 | } 12 | }, 13 | "references": [ 14 | { 15 | "path": "../db-base/tsconfig.json" 16 | }, 17 | ], 18 | "include": [ 19 | "src/**/*.ts", 20 | "src/**/*.js" // currently, we have js too 21 | ], 22 | "exclude": [ 23 | "build/**", 24 | "node_modules/**" 25 | ] 26 | } -------------------------------------------------------------------------------- /packages/db-states-file/src/index.ts: -------------------------------------------------------------------------------- 1 | export { StatesInMemoryFileDB } from './lib/states/statesInMemFileDB.js'; 2 | export { Client } from '@iobroker/db-states-redis'; 3 | export { StatesInMemoryServerClass as Server } from './lib/states/statesInMemServerClass.js'; 4 | 5 | /** 6 | * Get the default port of the objects db 7 | */ 8 | export function getDefaultPort(): number { 9 | return 9000; 10 | } 11 | -------------------------------------------------------------------------------- /packages/db-states-file/tsconfig.build.json: -------------------------------------------------------------------------------- 1 | // Specialized tsconfig to only compile .ts-files in the src dir 2 | { 3 | "extends": "./tsconfig.json", 4 | "compilerOptions": { 5 | "allowJs": true, 6 | "checkJs": false, 7 | "noEmit": false 8 | }, 9 | "references": [ 10 | { 11 | "path": "../db-base/tsconfig.build.json" 12 | }, 13 | { 14 | "path": "../db-states-redis/tsconfig.build.json" 15 | }, 16 | ], 17 | "include": [ 18 | "src/**/*.ts", 19 | "src/**/*.js" // currently, we have js too 20 | ], 21 | "exclude": [ 22 | "src/**/*.test.ts", 23 | "build/**", 24 | "node_modules/**" 25 | ] 26 | } -------------------------------------------------------------------------------- /packages/db-states-file/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json", 3 | "compilerOptions": { 4 | "outDir": "build/esm", 5 | "module": "NodeNext", 6 | "rootDir": "src", 7 | "noEmit": false, 8 | }, 9 | "references": [ 10 | { 11 | "path": "../db-base/tsconfig.json" 12 | }, 13 | { 14 | "path": "../db-states-redis/tsconfig.json" 15 | } 16 | ], 17 | "include": [ 18 | "src/**/*.ts", 19 | "src/**/*.js" 20 | ], 21 | "exclude": [ 22 | "build/**", 23 | "node_modules/**" 24 | ] 25 | } -------------------------------------------------------------------------------- /packages/db-states-jsonl/README.md: -------------------------------------------------------------------------------- 1 | # File DB JSONL states classes for ioBroker 2 | The Library contains the JSONL Database classes for File based states database client and server. 3 | 4 | ## License 5 | The MIT License (MIT) 6 | 7 | Copyright 2018-2024 bluefox 8 | -------------------------------------------------------------------------------- /packages/db-states-jsonl/src/index.ts: -------------------------------------------------------------------------------- 1 | export { Client } from '@iobroker/db-states-redis'; 2 | export { StatesInMemoryServerClass as Server } from './lib/states/statesInMemServerClass.js'; 3 | 4 | /** 5 | * Get the default port of the objects db 6 | */ 7 | export function getDefaultPort(): number { 8 | return 9000; 9 | } 10 | -------------------------------------------------------------------------------- /packages/db-states-jsonl/tsconfig.build.json: -------------------------------------------------------------------------------- 1 | // Specialized tsconfig to only compile .ts-files in the src dir 2 | { 3 | "extends": "./tsconfig.json", 4 | "compilerOptions": { 5 | "allowJs": true, 6 | "checkJs": false, 7 | "noEmit": false 8 | }, 9 | "references": [ 10 | { 11 | "path": "../db-base/tsconfig.build.json" 12 | }, 13 | { 14 | "path": "../db-states-file/tsconfig.build.json" 15 | }, 16 | { 17 | "path": "../db-states-redis/tsconfig.build.json" 18 | }, 19 | ], 20 | "include": [ 21 | "src/**/*.ts", 22 | "src/**/*.js" // currently, we have js too 23 | ], 24 | "exclude": [ 25 | "src/**/*.test.ts", 26 | "build/**", 27 | "node_modules/**" 28 | ] 29 | } -------------------------------------------------------------------------------- /packages/db-states-jsonl/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json", 3 | "compilerOptions": { 4 | "outDir": "build/esm", 5 | "module": "NodeNext", 6 | "rootDir": "src", 7 | "noEmit": false 8 | }, 9 | "references": [ 10 | { 11 | "path": "../db-base/tsconfig.json" 12 | }, 13 | { 14 | "path": "../db-states-file/tsconfig.json" 15 | }, 16 | { 17 | "path": "../db-states-redis/tsconfig.json" 18 | } 19 | ], 20 | "include": [ 21 | "src/**/*.ts", 22 | "src/**/*.js" 23 | ], 24 | "exclude": [ 25 | "build/**", 26 | "node_modules/**" 27 | ] 28 | } -------------------------------------------------------------------------------- /packages/db-states-redis/README.md: -------------------------------------------------------------------------------- 1 | # Redis DB states classes for ioBroker 2 | The Library contains the Database classes for Redis based states database client. 3 | 4 | ## License 5 | The MIT License (MIT) 6 | 7 | Copyright (c) 2014-2024 bluefox , 8 | Copyright (c) 2014 hobbyquaker 9 | -------------------------------------------------------------------------------- /packages/db-states-redis/src/index.ts: -------------------------------------------------------------------------------- 1 | /// 2 | export { StateRedisClient as Client } from '@/lib/states/statesInRedisClient.js'; 3 | export { interview } from '@/lib/states/interview.js'; 4 | /** 5 | * Get the default port for the database 6 | * 7 | * @param host string of host(s) 8 | */ 9 | export function getDefaultPort(host: string): number { 10 | return host.includes(',') ? 26379 : 6379; 11 | } 12 | export const Server = null; 13 | -------------------------------------------------------------------------------- /packages/db-states-redis/src/lib/states/interview.ts: -------------------------------------------------------------------------------- 1 | import { defaultRedisInterview } from '@iobroker/js-controller-common-db'; 2 | 3 | /** 4 | * Custom interview during setup 5 | * 6 | * @param config the prefilled database config 7 | */ 8 | export function interview(config: ioBroker.StatesDatabaseOptions): Promise { 9 | return defaultRedisInterview({ config, type: 'states' }); 10 | } 11 | -------------------------------------------------------------------------------- /packages/db-states-redis/tsconfig.build.json: -------------------------------------------------------------------------------- 1 | // Specialized tsconfig to only compile .ts-files in the src dir 2 | { 3 | "extends": "./tsconfig.json", 4 | "compilerOptions": { 5 | "allowJs": false, 6 | "checkJs": false, 7 | "noEmit": false 8 | }, 9 | "references": [ 10 | { 11 | "path": "../db-base/tsconfig.build.json" 12 | }, 13 | ], 14 | "include": [ 15 | "src/**/*.ts", 16 | "src/**/*.js" // currently, we have js too 17 | ], 18 | "exclude": [ 19 | "src/**/*.test.ts", 20 | "build/**", 21 | "node_modules/**" 22 | ] 23 | } -------------------------------------------------------------------------------- /packages/db-states-redis/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json", 3 | "compilerOptions": { 4 | "outDir": "build/esm", 5 | "module": "NodeNext", 6 | "rootDir": "src", 7 | "paths": { 8 | "@/*": [ 9 | "./src/*" 10 | ] 11 | } 12 | }, 13 | "references": [ 14 | { 15 | "path": "../db-base/tsconfig.json" 16 | }, 17 | ], 18 | "include": [ 19 | "src/**/*.ts" 20 | ], 21 | "exclude": [ 22 | "build/**", 23 | "node_modules/**" 24 | ] 25 | } -------------------------------------------------------------------------------- /packages/types-dev/LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2023-2024 foxriver76, 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in 13 | all copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 | THE SOFTWARE. 22 | -------------------------------------------------------------------------------- /packages/types-dev/README.md: -------------------------------------------------------------------------------- 1 | This package contains types that can be shared withing this repository without introducing circular dependencies. -------------------------------------------------------------------------------- /packages/types-dev/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@iobroker/types-dev", 3 | "private": true, 4 | "version": "7.0.8-alpha.2-20250522-ec9b0b016", 5 | "engines": { 6 | "node": ">=12.0.0" 7 | }, 8 | "keywords": [ 9 | "ioBroker" 10 | ], 11 | "author": "foxriver76 ", 12 | "contributors": [ 13 | "foxriver76 " 14 | ], 15 | "repository": { 16 | "type": "git", 17 | "url": "https://github.com/ioBroker/ioBroker.js-controller/tree/master/packages/types-dev" 18 | }, 19 | "main": "", 20 | "types": "index.d.ts", 21 | "license": "MIT", 22 | "publishConfig": { 23 | "access": "public" 24 | }, 25 | "files": [ 26 | "index.d.ts", 27 | "config.d.ts", 28 | "objects.d.ts", 29 | "utils.d.ts", 30 | "LICENSE" 31 | ] 32 | } 33 | -------------------------------------------------------------------------------- /packages/types-dev/utils.d.ts: -------------------------------------------------------------------------------- 1 | declare const __brand: unique symbol; 2 | type Brand = { [__brand]: B }; 3 | export type Branded = T & Brand; 4 | -------------------------------------------------------------------------------- /packages/types-public/LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2023-2024 foxriver76, 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in 13 | all copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 | THE SOFTWARE. 22 | -------------------------------------------------------------------------------- /packages/types-public/README.md: -------------------------------------------------------------------------------- 1 | # Type definitions for ioBroker 2 | 3 | ## Usage 4 | 5 | Since this package does not start with `@types/`, the types are not automatically included in your project. You need to add a reference to this package in your `tsconfig.json`: 6 | 7 | ```json 8 | { 9 | "compilerOptions": { 10 | "types": ["node", "@iobroker/types"] 11 | } 12 | } 13 | ``` 14 | 15 | or by adding an import to a file in your project: 16 | 17 | ```ts 18 | import '@iobroker/types'; 19 | ``` -------------------------------------------------------------------------------- /packages/types-public/api-extractor.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", 3 | "mainEntryPointFilePath": "../adapter/build/cjs/index.d.ts", 4 | "tsdocMetadata": { 5 | "enabled": false 6 | }, 7 | "apiReport": { 8 | "enabled": false 9 | }, 10 | "docModel": { 11 | "enabled": false 12 | }, 13 | "dtsRollup": { 14 | "enabled": true, 15 | "untrimmedFilePath": "./build/types.d.ts" 16 | }, 17 | "bundledPackages": [] 18 | } 19 | -------------------------------------------------------------------------------- /packages/types-public/index.d.ts: -------------------------------------------------------------------------------- 1 | import './build/shared'; 2 | import './public'; 3 | -------------------------------------------------------------------------------- /packages/types-public/index.js: -------------------------------------------------------------------------------- 1 | // this empty file is needed as a entry point for adapter-core to export the `@iobroker/types` in a developer friendly way 2 | -------------------------------------------------------------------------------- /packages/types-public/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@iobroker/types", 3 | "version": "7.0.8-alpha.2-20250522-ec9b0b016", 4 | "engines": { 5 | "node": ">=12.0.0" 6 | }, 7 | "keywords": [ 8 | "ioBroker" 9 | ], 10 | "author": "foxriver76 ", 11 | "contributors": [ 12 | "foxriver76 " 13 | ], 14 | "repository": { 15 | "type": "git", 16 | "url": "https://github.com/ioBroker/ioBroker.js-controller/tree/master/packages/types-public" 17 | }, 18 | "scripts": { 19 | "build": "ts-node build.ts", 20 | "test": "tsd" 21 | }, 22 | "main": "index.js", 23 | "types": "index.d.ts", 24 | "license": "MIT", 25 | "publishConfig": { 26 | "access": "public" 27 | }, 28 | "devDependencies": { 29 | "tsd": "^0.31.2" 30 | }, 31 | "files": [ 32 | "build/", 33 | "index.d.ts", 34 | "public.d.ts", 35 | "LICENSE" 36 | ], 37 | "tsd": { 38 | "compilerOptions": { 39 | "types": [ 40 | "@iobroker/types" 41 | ] 42 | } 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /packages/types-public/public.d.ts: -------------------------------------------------------------------------------- 1 | // Types which are only safe to share publicly 2 | 3 | import type { AdapterClass, AdapterOptions as _AdapterOptions } from './build/types'; 4 | 5 | declare global { 6 | namespace ioBroker { 7 | type Adapter = AdapterClass; 8 | 9 | type AdapterOptions = _AdapterOptions; 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /prettier.config.mjs: -------------------------------------------------------------------------------- 1 | import prettierConfig from '@iobroker/eslint-config/prettier.config.mjs'; 2 | 3 | export default prettierConfig; 4 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "@tsconfig/node22/tsconfig.json", 3 | "compilerOptions": { 4 | // Pass js files through to the build dir 5 | // but don't complain about errors 6 | "allowJs": true, 7 | "checkJs": false, 8 | // Monorepo setup with project references 9 | "composite": true, 10 | "declaration": true, // generate .d.ts files 11 | "declarationMap": true, // generate .map files for .d.ts files 12 | "sourceMap": true, // generate .map files for .js files 13 | "inlineSourceMap": false, // Alternatively, inline the source maps 14 | // Don't emit anything by default. This will be turned on in the subprojects 15 | "noEmit": true, 16 | // Avoid TS errors in external dependencies 17 | "skipLibCheck": true, 18 | // Enable syntax help for importing JSON files 19 | "resolveJsonModule": true, 20 | "useUnknownInCatchVariables": false, 21 | "pretty": true 22 | }, 23 | "include": [ 24 | "*.config.mjs", 25 | "packages/**/*.js", 26 | "packages/**/*.ts", 27 | "packages/controller/io-package.json", 28 | "schemas/**/*.ts" 29 | ], 30 | "exclude": [ 31 | "packages/**/build" 32 | ] 33 | } 34 | --------------------------------------------------------------------------------