@iobroker/socket-classes
Advanced tools
This library is used at least for the following adapters:
const TTL_SEC = 3600;
const SocketAdmin = require('@iobroker/socket-classes').SocketAdmin;
const ws = require('@iobroker/ws-server');
const session = require('express-session');
const utils = require('@iobroker/adapter-core'); // Get common adapter utils
const AdapterStore = require(utils.controllerDir + '/lib/session.js')(session, TTL_SEC);
const store = new AdapterStore({adapter});
const io = new SocketAdmin(adapter.config, adapter, objects);
io.start(
server,
ws,
{
userKey: 'connect.sid',
store,
secret: adapter.config.secret
}
);
// subscribe on all object changes
io.subscribe('objectChange', '*');
// later
io.close();
const TTL_SEC = 3600;
const ws = require('@iobroker/ws-server');
const SocketWS = require('@iobroker/socket-classes').SocketCommon;
const session = require('express-session');
const utils = require('@iobroker/adapter-core'); // Get common adapter utils
const AdapterStore = require(utils.controllerDir + '/lib/session.js')(session, TTL_SEC);
const store = new AdapterStore({adapter});
const settings = adapter.config;
settings.crossDomain = true;
settings.ttl = settings.ttl || TTL_SEC;
const io = new SocketWS(settings, adapter);
io.start(server.server, ws, {userKey: 'connect.sid', checkUser, store, secret: adapter.config.secret});
// later
io.close();
GUI client can send to desired instance the subscribe message
socket.emit('clientSubscribe', 'cameras.0', 'startCamera', { width: 640, height: 480 }, result => console.log('Started: ' + result));
The instance 'cameras.0' will receive message clientSubscribe with information who want to receive messages.
adapter.on('message', obj => {
if (obj?.command === 'clientSubscribe') {
if (obj?.message.type && obj.message.type.startsWith('startCamera/')) {
const [, camera] = obj.message.type.split('/');
// start camera with obj.message.data
// ...
// inform GUI that camera is started
adapter.sendTo(obj.from, obj.command, {result: true}, obj.callback);
this.subscribes = this.subscribes || [];
this.subscribes.push({sid: obj.message.sid, from: obj.from, type: obj.message.type, camera});
}
} else if (obj?.command === 'clientUnsubscribe' || obj?.command === 'clientSubscribeError') {
if (obj?.message.type && obj.message.type.startsWith('startCamera/')) {
const [, camera] = obj.message.type.split('/');
if (this.subscribes) {
const pos = this.subscribes.findIndex(s => s.sid === obj.message.sid && s.from === obj.from && s.type === obj.message.type);
if (pos !== -1) {
this.subscribes.splice(pos, 1);
// stop camera
// ...
}
}
}
}
});
and after that client will receive messages from instance
function sendImage(camera, data) {
this.subscribes.forEach(it => {
if (it.camera !== camera) {
return;
}
// send image to GUI
adapter.sendTo(it.from, 'im', {m: it.type, s: it.sid, d: data});
});
}
authenticateupdateTokenExpirationerrorlogcheckFeatureSupportedgetHistoryhttpGetsendTosendToHostauthEnabledlogoutlistPermissionsgetUserPermissionsgetVersiongetAdapterNameclientSubscribeclientUnsubscribegetAdapterInstancesgetObjectgetObjectssubscribeObjectsunsubscribeObjectsgetObjectViewsetObjectdelObjectgetStatesgetForeignStatesgetStatesetStategetBinaryStatesetBinaryStatesubscribesubscribeStatesunsubscribeunsubscribeStatesreadFilereadFile64writeFile64writeFileunlinkdeleteFiledeleteFolderrenameFilerenamemkdirreadDirchmodFilechownFilefileExistssubscribeFilesunsubscribeFilesauthenticate(callback)Wait till the user is authenticated. As the user authenticates himself, the callback will be called
callback (isUserAuthenticated: boolean, isAuthenticationUsed: boolean) => void) => void: Callback (isUserAuthenticated: boolean, isAuthenticationUsed: boolean) => voidupdateTokenExpiration(accessToken, callback)After the access token is updated, this command must be called to update the session (Only for OAuth2)
accessToken string: New access tokencallback (error: string | undefined | null, success?: boolean) => void) => void: Callback (error: string | undefined | null, success?: boolean) => voiderror(error)Write error into ioBroker log
error Error | string: Error object or error textlog(text, level)Write log entry into ioBroker log
text string: log textlevel ioBroker.LogLevel: one of ['silly', 'debug', 'info', 'warn', 'error']. Default is 'debug'.checkFeatureSupported(feature, callback)Check if the same feature is supported by the current js-controller
feature SupportedFeature: feature name like CONTROLLER_LICENSE_MANAGERcallback (error: string | Error | null | undefined, isSupported?: boolean) => void) => void: callback (error: string | Error | null | undefined, isSupported: boolean) => voidgetHistory(id, options, callback)Get history data from specific instance
id string: object IDoptions ioBroker.GetHistoryOptions: History optionscallback (error: string | Error | null | undefined, result: ioBroker.GetHistoryResult) => void) => void: callback (error: string | Error | null | undefined, result: ioBroker.GetHistoryResult) => voidhttpGet(url, callback)Read content of HTTP(s) page server-side (without CORS and stuff)
url string: Page URLcallback (error: Error | null | undefined | string, result?: {status: number; statusText: string}, data?: string) => void: callback (error: Error | null, result?: { status: number; statusText: string }, data?: string) => voidsendTo(adapterInstance, command, message, callback)Send the message to specific instance
adapterInstance string: instance name, e.g. history.0command string: command namemessage any: the message is instance-dependentcallback (result: any) => void) => void: callback (result: any) => voidsendToHost(host, command, message, callback)Send a message to the specific host.
Host can answer to the following commands: cmdExec, getRepository, getInstalled, getInstalledAdapter, getVersion, getDiagData, getLocationOnDisk, getDevList, getLogs, getHostInfo, delLogs, readDirAsZip, writeDirAsZip, readObjectsAsZip, writeObjectsAsZip, checkLogging, updateMultihost.
host string: Host name. With or without 'system.host.' prefixcommand * 'shell' | 'cmdExec' | 'getRepository' | 'getInstalled' | 'getInstalledAdapter' | 'getVersion' | 'getDiagData' | 'getLocationOnDisk' | 'getDevList' | 'getLogs' | 'getLogFile' | 'getLogFiles' | 'getHostInfo' | 'getHostInfoShort' | 'delLogs' | 'readDirAsZip' | 'writeDirAsZip' | 'readObjectsAsZip' | 'writeObjectsAsZip' | 'checkLogging' | 'updateMultihost' | 'upgradeController' | 'upgradeAdapterWithWebserver' | 'getInterfaces' | 'upload' | 'rebuildAdapter' | 'readBaseSettings' | 'writeBaseSettings' | 'addNotification' | 'clearNotifications' | 'getNotifications' | 'updateLicenses' | 'upgradeOsPackages' | 'restartController' | 'sendToSentry'*: Host commandmessage any: the message is command-specificcallback (result: {error?: string; result?: any}) => void) => void: callback (result: { error?: string; result?: any }) => voidauthEnabled(callback)Ask server is authentication enabled, and if the user authenticated
callback (isUserAuthenticated: boolean | Error | string, isAuthenticationUsed: boolean) => void) => void: callback (isUserAuthenticated: boolean | Error | string, isAuthenticationUsed: boolean) => voidlogout(callback)Logout user
callback ioBroker.ErrorCallback: callback (error?: Error) => voidlistPermissions(callback)List commands and permissions
callback (permissions: Record< string, {type: 'object' | 'state' | 'users' | 'other' | 'file' | ''; operation: SocketOperation} >) => void: callback (permissions: Record<string, { type: 'object' | 'state' | 'users' | 'other' | 'file' | ''; operation: SocketOperation }>) => voidgetUserPermissions(callback)Get user permissions
callback (error: string | null | undefined, userPermissions?: SocketACL | null) => void) => void: callback (error: string | null | undefined, userPermissions?: SocketACL | null) => voidgetVersion(callback)Get the adapter version. Not the socket-classes version!
callback (error: string | Error | null | undefined, version: string | undefined, adapterName: string) => void: callback (error: string | Error | null | undefined, version: string | undefined, adapterName: string) => voidgetAdapterName(callback)Get adapter name: "iobroker.ws", "iobroker.socketio", "iobroker.web", "iobroker.admin"
callback (error: string | Error | null | undefined, adapterName: string) => void) => void: callback (error: string | Error | null | undefined, version: string | undefined, adapterName: string) => voidclientSubscribe(targetInstance, messageType, data, callback)Client subscribes to specific instance's messages. Client informs specific instance about subscription on its messages. After subscription, the socket will receive "im" messages from desired instance The target instance MUST acknowledge the subscription and return result
targetInstance string: Instance name, e.g., 'cameras.0'messageType string: Message type, e.g., 'startRecording/cam1'data any: Optional data object, e.g., {width: 640, height: 480}callback (error: string | null | Error | undefined, result?: {accepted: boolean; heartbeat?: number; error?: string}) => void: Callback (error: string | null, result?:{ accepted: boolean; heartbeat?: number; error?: string; }) => voidclientUnsubscribe(targetInstance, messageType, callback)Client unsubscribes from specific instance's messages. The target instance MUST NOT acknowledge the un-subscription
targetInstance string: Instance name, e.g., 'cameras.0'messageType string: Message type, e.g., 'startRecording/cam1'callback (error: string | null | Error | undefined) => void) => void: Callback (error: string | null) => voidgetAdapterInstances(adapterName, callback)Read all instances of the given adapter, or all instances of all adapters if adapterName is not defined
adapterName string | undefined: adapter name, e.g. history. To get all instances of all adapters just place here "".callback (error: null | undefined | Error | string, instanceList?: ioBroker.InstanceObject[]) => void) => void: callback (error: null | undefined | Error | string, instanceList?: ioBroker.InstanceObject[]) => voidgetObject(id, callback)Get one object.
id string: Object IDcallback (error: Error | undefined | string | null, obj?: ioBroker.Object) => void) => void: Callback (error: string | null, obj?: ioBroker.Object) => voidgetObjects(list, callback)Get all objects that are relevant for web: all states and enums with rooms. This is non-admin version of "all objects" and will be overloaded in admin
list string[] | null: Optional list of IDscallback (error: Error | undefined | string | null, objs?: Record<string, ioBroker.Object>) => void) => void: Callback (error: string | null, objs?: Record<string, ioBroker.Object>) => voidsubscribeObjects(pattern, callback)Subscribe to object changes by pattern. The events will come as 'objectChange' events to the socket.
pattern string | string[]: Pattern like system.adapter.* or array of IDs like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']callback (error: Error | undefined | string | null) => void) => void: Callback (error: string | null) => voidunsubscribeObjects(pattern, callback)Unsubscribe from object changes by pattern.
pattern string | string[]: Pattern like system.adapter.* or array of IDs like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']callback (error: string | null | Error | undefined) => void) => void: Callback (error: string | null) => voidgetObjectView(design, search, params, callback)Get a view of objects. Make a query to the object database.
design string: Design name, e.g., 'system' or other designs like custom, but it must exist object _design/custom. To 99,9% use system.search string: Search name, object type, like state, instance, adapter, host, ...params {startkey?: string; endkey?: string; depth?: number}: Parameters for the query, e.g., {startkey: 'system.adapter.', endkey: 'system.adapter.\u9999', depth?: number}callback (error: string | null | Error | undefined, result?: {rows: {id: string; value: ioBroker.Object & {virtual: boolean; hasChildren: number;};}[];}) => void: Callback (error: string | null, result?: { rows: Array<GetObjectViewItem> }) => voidsetObject(id, obj, callback)Set an object.
id string: Object IDobj ioBroker.Object: Object to setcallback (error: string | null | Error | undefined) => void) => void: Callback (error: string | null) => voiddelObject(id, _options, callback)Delete an object. Only deletion of flot and fullcalendar objects is allowed
id string: Object ID, like 'flot.0.myChart'_options any: Options for deletion. Ignoredcallback (error: string | null | Error | undefined) => void) => void: Callback (error: string | null) => voidgetStates(pattern, callback)Get states by pattern of current adapter
pattern string | string[] | undefined: optional pattern, like system.adapter.* or array of state IDs. If the pattern is omitted, you will get ALL states of current adaptercallback (error: null | undefined | Error | string, states?: Record<string, ioBroker.State>) => void) => void: callback (error: null | undefined | Error | string, states?: Record<string, ioBroker.State>) => voidgetForeignStates(pattern, callback)Same as getStates
pattern string | string[]: pattern like system.adapter.* or array of state IDscallback (error: null | undefined | Error | string, states?: Record<string, ioBroker.State>) => void) => void: callback (error: null | undefined | Error | string, states?: Record<string, ioBroker.State>) => voidgetState(id, callback)Get a state by ID
id string: State ID, e.g. system.adapter.admin.0.memRsscallback (error: null | undefined | Error | string, state?: ioBroker.State) => void) => void: Callback (error: null | undefined | Error | string, state?: ioBroker.State) => voidsetState(id, state, callback)Set a state by ID
id string: State ID, e.g. system.adapter.admin.0.memRssstate ioBroker.SettableState: State value or object, e.g. {val: 123, ack: true}callback (error: null | undefined | Error | string, state?: ioBroker.State) => void) => void: Callback (error: null | undefined | Error | string, state?: ioBroker.State) => voidgetBinaryState(id, callback)Get a binary state by ID
id string: State ID, e.g. javascript.0.binarycallback (error: null | undefined | Error | string, base64?: string) => void) => void: Callback (error: null | undefined | Error | string, base64?: string) => voidsetBinaryState(id, _base64, callback)Set a binary state by ID
id string: State ID, e.g. javascript.0.binary_base64 string: State value as base64 string. Binary states have no acknowledged flag.callback (error: null | undefined | Error | string) => void) => void: Callback (error: null | undefined | Error | string) => voidsubscribe(pattern, callback)Subscribe to state changes by pattern. The events will come as 'stateChange' events to the socket.
pattern string | string[]: Pattern like system.adapter.* or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']callback (error: string | null) => void) => void: Callback (error: string | null) => voidsubscribeStates(pattern, callback)Subscribe to state changes by pattern. Same as subscribe.
The events will come as 'stateChange' events to the socket.
pattern string | string[]: Pattern like system.adapter.* or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']callback (error: string | null) => void) => void: Callback (error: string | null) => voidunsubscribe(pattern, callback)Unsubscribe from state changes by pattern.
pattern string | string[]: Pattern like system.adapter.* or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']callback (error: string | null) => void) => void: Callback (error: string | null) => voidunsubscribeStates(pattern, callback)Unsubscribe from state changes by pattern. Same as unsubscribe.
The events will come as 'stateChange' events to the socket.
pattern string | string[]: Pattern like system.adapter.* or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']callback (error: string | null) => void) => void: Callback (error: string | null) => voidreadFile(adapter, fileName, callback)Read a file from ioBroker DB
adapter string: instance name, e.g. vis.0fileName string: file name, e.g. main/vis-views.jsoncallback (error: null | undefined | Error | string, data: Buffer | string, mimeType: string) => void) => void: Callback (error: null | undefined | Error | string, data: Buffer | string, mimeType: string) => voidreadFile64(adapter, fileName, callback)Read a file from ioBroker DB as base64 string
adapter string: instance name, e.g. vis.0fileName string: file name, e.g. main/vis-views.jsoncallback (error: null | undefined | Error | string, base64?: string, mimeType?: string) => void) => void: Callback (error: null | undefined | Error | string, base64: string, mimeType: string) => voidwriteFile64(adapter, fileName, data64, options, callback?)Write a file into ioBroker DB as base64 string
adapter string: instance name, e.g. vis.0fileName string: file name, e.g. main/vis-views.jsondata64 string: file content as base64 stringoptions {mode?: number} | ((error: null | undefined | Error | string) => void): optional {mode: 0x0644}callback? (error: null | undefined | Error | string) => void: Callback (error: null | undefined | Error | string) => voidwriteFile(adapter, fileName, data, options, callback?)Write a file into ioBroker DB as text This function is overloaded in admin (because admin accepts only base64)
adapter string: instance name, e.g. vis.0fileName string: file name, e.g. main/vis-views.jsondata string: file content as textoptions {mode?: number} | ((error: null | undefined | Error | string) => void): optional {mode: 0x0644}callback? (error: null | undefined | Error | string) => void: Callback (error: null | undefined | Error | string) => voidunlink(adapter, name, callback)Delete file in ioBroker DB
adapter string: instance name, e.g. vis.0name string: file name, e.g. main/vis-views.jsoncallback (error: null | undefined | Error | string) => void) => void: Callback (error: null | undefined | Error | string) => voiddeleteFile(adapter, name, callback)Delete a file in ioBroker DB (same as "unlink", but only for files)
adapter string: instance name, e.g. vis.0name string: file name, e.g. main/vis-views.jsoncallback (error: null | undefined | Error | string) => void) => void: Callback (error: null | undefined | Error | string) => voiddeleteFolder(adapter, name, callback)Delete folder in ioBroker DB (same as unlink, but only for folders)
adapter string: instance name, e.g. vis.0name string: folder name, e.g. maincallback (error: null | undefined | Error | string) => void) => void: Callback (error: null | undefined | Error | string) => voidrenameFile(adapter, oldName, newName, callback)Rename a file in ioBroker DB
adapter string: instance name, e.g. vis.0oldName string: current file name, e.g. main/vis-views.jsonnewName string: new file name, e.g. main/vis-views-new.jsoncallback (error: null | undefined | Error | string) => void) => void: Callback (error: null | undefined | Error | string) => voidrename(adapter, oldName, newName, callback)Rename file or folder in ioBroker DB
adapter string: instance name, e.g. vis.0oldName string: current file name, e.g. main/vis-views.jsonnewName string: new file name, e.g. main/vis-views-new.jsoncallback (error: null | undefined | Error | string) => void) => void: Callback (error: null | undefined | Error | string) => voidmkdir(adapter, dirName, callback)Create a folder in ioBroker DB
adapter string: instance name, e.g. vis.0dirName string: desired folder name, e.g. maincallback (error: null | undefined | Error | string) => void) => void: Callback (error: null | undefined | Error | string) => voidreadDir(adapter, dirName, options, callback?)Read content of folder in ioBroker DB
adapter string: instance name, e.g. vis.0dirName string: folder name, e.g. mainoptions object | ((error: null | undefined | Error | string, files: ioBroker.ReadDirResult[]) => void): for future usecallback? (error: null | undefined | Error | string, files: ioBroker.ReadDirResult[]) => void: Callback (error: null | undefined | Error | string, files: Array<{file: string, isDir: boolean, stats: {size: number}, modifiedAt: number, acl: {owner: string, ownerGroup: string, permissions: number, read: boolean, write: boolean}}>) => voidchmodFile(adapter, fileName, options, callback?)Change a file mode in ioBroker DB
adapter string: instance name, e.g. vis.0fileName string: file name, e.g. main/vis-views.jsonoptions {mode?: number}: options {mode: 0x644}callback? (error: string | Error | null | undefined) => void: Callback (error: string | Error | null | undefined) => voidchownFile(adapter, fileName, options, callback?)Change file owner in ioBroker DB
adapter string: instance name, e.g. vis.0fileName string: file name, e.g. main/vis-views.jsonoptions {owner: system.user.${string}; ownerGroup?: system.group.${string}}: options {owner: 'system.user.user', ownerGroup: 'system.group.administrator'} or system.user.user. If ownerGroup is not defined, it will be taken from owner.callback? (error: null | undefined | Error | string) => void: Callback (error: null | undefined | Error | string) => voidfileExists(adapter, fileName, callback)Check if the file or folder exists in ioBroker DB
adapter string: instance name, e.g. vis.0fileName string: file name, e.g. main/vis-views.jsoncallback (error: null | undefined | Error | string, exists?: boolean) => void) => void: Callback (error: null | undefined | Error | string, exists?: boolean) => voidsubscribeFiles(id, pattern, callback)Subscribe to file changes in ioBroker DB
id string: instance name, e.g. vis.0 or any object ID of type meta. id could have wildcards * too.pattern string | string[]: file name pattern, e.g. main/*.json or array of namescallback (error: null | undefined | Error | string) => void) => void: Callback (error: null | undefined | Error | string) => voidunsubscribeFiles(id, pattern, callback)Unsubscribe from file changes in ioBroker DB
id string: instance name, e.g. vis.0 or any object ID of type meta. id could have wildcards * too.pattern string | string[]: file name pattern, e.g. main/*.json or array of namescallback (error: null | undefined | Error | string) => void) => void: Callback (error: null | undefined | Error | string) => voidauthenticateupdateTokenExpirationerrorlogcheckFeatureSupportedgetHistoryhttpGetsendTosendToHostauthEnabledlogoutlistPermissionsgetUserPermissionsgetVersiongetAdapterNameclientSubscribeclientUnsubscribegetAdapterInstancesgetHostByIprequireLogreadLogscmdExeceventsThresholdgetRatingsgetCurrentInstancedecryptencryptgetIsEasyModeStrictgetEasyModegetAdaptersupdateLicensesgetCompactInstancesgetCompactAdaptersgetCompactInstalledgetCompactSystemConfiggetCompactSystemRepositoriesgetCompactRepositorygetCompactHostsdelStategetStatesgetForeignStatesgetStatesetStategetBinaryStatesetBinaryStatesubscribesubscribeStatesunsubscribeunsubscribeStatesaddUserdelUseraddGroupdelGroupchangePasswordgetObjectgetObjectssubscribeObjectsunsubscribeObjectsgetObjectViewsetObjectdelObjectgetAllObjectsextendObjectgetForeignObjectsdelObjectsreadFilereadFile64writeFile64writeFileunlinkdeleteFiledeleteFolderrenameFilerenamemkdirreadDirchmodFilechownFilefileExistssubscribeFilesunsubscribeFilesauthenticate(callback)Wait till the user is authenticated. As the user authenticates himself, the callback will be called
callback (isUserAuthenticated: boolean, isAuthenticationUsed: boolean) => void) => void: Callback (isUserAuthenticated: boolean, isAuthenticationUsed: boolean) => voidupdateTokenExpiration(accessToken, callback)After the access token is updated, this command must be called to update the session (Only for OAuth2)
accessToken string: New access tokencallback (error: string | undefined | null, success?: boolean) => void) => void: Callback (error: string | undefined | null, success?: boolean) => voiderror(error)Write error into ioBroker log
error Error | string: Error object or error textlog(text, level)Write log entry into ioBroker log
text string: log textlevel ioBroker.LogLevel: one of ['silly', 'debug', 'info', 'warn', 'error']. Default is 'debug'.checkFeatureSupported(feature, callback)Check if the same feature is supported by the current js-controller
feature SupportedFeature: feature name like CONTROLLER_LICENSE_MANAGERcallback (error: string | Error | null | undefined, isSupported?: boolean) => void) => void: callback (error: string | Error | null | undefined, isSupported: boolean) => voidgetHistory(id, options, callback)Get history data from specific instance
id string: object IDoptions ioBroker.GetHistoryOptions: History optionscallback (error: string | Error | null | undefined, result: ioBroker.GetHistoryResult) => void) => void: callback (error: string | Error | null | undefined, result: ioBroker.GetHistoryResult) => voidhttpGet(url, callback)Read content of HTTP(s) page server-side (without CORS and stuff)
url string: Page URLcallback (error: Error | null | undefined | string, result?: {status: number; statusText: string}, data?: string) => void: callback (error: Error | null, result?: { status: number; statusText: string }, data?: string) => voidsendTo(adapterInstance, command, message, callback)Send the message to specific instance
adapterInstance string: instance name, e.g. history.0command string: command namemessage any: the message is instance-dependentcallback (result: any) => void) => void: callback (result: any) => voidsendToHost(host, command, message, callback)Send a message to the specific host.
Host can answer to the following commands: cmdExec, getRepository, getInstalled, getInstalledAdapter, getVersion, getDiagData, getLocationOnDisk, getDevList, getLogs, getHostInfo, delLogs, readDirAsZip, writeDirAsZip, readObjectsAsZip, writeObjectsAsZip, checkLogging, updateMultihost.
host string: Host name. With or without 'system.host.' prefixcommand * 'shell' | 'cmdExec' | 'getRepository' | 'getInstalled' | 'getInstalledAdapter' | 'getVersion' | 'getDiagData' | 'getLocationOnDisk' | 'getDevList' | 'getLogs' | 'getLogFile' | 'getLogFiles' | 'getHostInfo' | 'getHostInfoShort' | 'delLogs' | 'readDirAsZip' | 'writeDirAsZip' | 'readObjectsAsZip' | 'writeObjectsAsZip' | 'checkLogging' | 'updateMultihost' | 'upgradeController' | 'upgradeAdapterWithWebserver' | 'getInterfaces' | 'upload' | 'rebuildAdapter' | 'readBaseSettings' | 'writeBaseSettings' | 'addNotification' | 'clearNotifications' | 'getNotifications' | 'updateLicenses' | 'upgradeOsPackages' | 'restartController' | 'sendToSentry'*: Host commandmessage any: the message is command-specificcallback (result: {error?: string; result?: any}) => void) => void: callback (result: { error?: string; result?: any }) => voidauthEnabled(callback)Ask server is authentication enabled, and if the user authenticated
callback (isUserAuthenticated: boolean | Error | string, isAuthenticationUsed: boolean) => void) => void: callback (isUserAuthenticated: boolean | Error | string, isAuthenticationUsed: boolean) => voidlogout(callback)Logout user
callback ioBroker.ErrorCallback: callback (error?: Error) => voidlistPermissions(callback)List commands and permissions
callback (permissions: Record< string, {type: 'object' | 'state' | 'users' | 'other' | 'file' | ''; operation: SocketOperation} >) => void: callback (permissions: Record<string, { type: 'object' | 'state' | 'users' | 'other' | 'file' | ''; operation: SocketOperation }>) => voidgetUserPermissions(callback)Get user permissions
callback (error: string | null | undefined, userPermissions?: SocketACL | null) => void) => void: callback (error: string | null | undefined, userPermissions?: SocketACL | null) => voidgetVersion(callback)Get the adapter version. Not the socket-classes version!
callback (error: string | Error | null | undefined, version: string | undefined, adapterName: string) => void: callback (error: string | Error | null | undefined, version: string | undefined, adapterName: string) => voidgetAdapterName(callback)Get adapter name: "iobroker.ws", "iobroker.socketio", "iobroker.web", "iobroker.admin"
callback (error: string | Error | null | undefined, adapterName: string) => void) => void: callback (error: string | Error | null | undefined, version: string | undefined, adapterName: string) => voidclientSubscribe(targetInstance, messageType, data, callback)Client subscribes to specific instance's messages. Client informs specific instance about subscription on its messages. After subscription, the socket will receive "im" messages from desired instance The target instance MUST acknowledge the subscription and return result
targetInstance string: Instance name, e.g., 'cameras.0'messageType string: Message type, e.g., 'startRecording/cam1'data any: Optional data object, e.g., {width: 640, height: 480}callback (error: string | null | Error | undefined, result?: {accepted: boolean; heartbeat?: number; error?: string}) => void: Callback (error: string | null, result?:{ accepted: boolean; heartbeat?: number; error?: string; }) => voidclientUnsubscribe(targetInstance, messageType, callback)Client unsubscribes from specific instance's messages. The target instance MUST NOT acknowledge the un-subscription
targetInstance string: Instance name, e.g., 'cameras.0'messageType string: Message type, e.g., 'startRecording/cam1'callback (error: string | null | Error | undefined) => void) => void: Callback (error: string | null) => voidgetAdapterInstances(adapterName, callback)Read all instances of the given adapter, or all instances of all adapters if adapterName is not defined
adapterName string | undefined: adapter name, e.g. history. To get all instances of all adapters just place here "".callback (error: null | undefined | Error | string, instanceList?: ioBroker.InstanceObject[]) => void) => void: callback (error: null | undefined | Error | string, instanceList?: ioBroker.InstanceObject[]) => voidgetHostByIp(ip, callback?)Read the host object by IP address.
ip string: - IP address, e.g., 192.168.1.1. IPv4 or IPv6callback? (error: string | null | Error | undefined, hostObject?: ioBroker.HostObject | null) => void: - Callback function (ip: string, obj: ioBroker.HostObject | null) => voidrequireLog(isEnabled, callback?)Activate or deactivate logging events. Events will be sent to the socket as log event. Adapter must have common.logTransporter = true.
isEnabled boolean: - Is logging enabledcallback? (error: string | null | Error | undefined) => void: - Callback function (error: string | null) => voidreadLogs(host, callback?)Get the log files from the given host.
host string: - Host ID, e.g., system.host.raspberrypicallback? (error: string | null | Error | undefined, list?: {fileName: string; size: number}[]) => void: - Callback function (error: string | null, list?: { fileName: string; size: number }[]) => voidcmdExec(host, id, cmd, callback?)Execute the shell command on host/controller.
Following response commands are expected: cmdStdout, cmdStderr, cmdExit.
host string: - Host name, e.g., system.host.raspberrypiid number: - Session ID, e.g., Date.now(). This session ID will come in events cmdStdout, cmdStderr, cmdExitcmd string: - Command to executecallback? (error: string | null | Error | undefined) => void: - Callback function (error: string | null) => voideventsThreshold(isActive)Enable or disable the event threshold. Used only for admin to limit the number of events to the front-end.
isActive boolean: - If true, then events will be limitedgetRatings(update, callback?)Get the ratings of adapters.
update boolean | ((error: string | null | Error | undefined, ratings?: Ratings) => void): - If true, the ratings will be read from the central server, if false from the local cachecallback? (error: string | null | Error | undefined, ratings?: Ratings) => void: - Callback function (error: string | null, ratings?: Ratings) => voidgetCurrentInstance(callback)Get the current instance name, like "admin.0"
callback (error: string | null | Error | undefined, namespace: string) => void) => void: - Callback function (error: string | null, namespace?: string) => voiddecrypt(encryptedText, callback)Decrypts text with the system secret key.
encryptedText string: - Encrypted textcallback (error: string | null | Error | undefined, decryptedText?: string) => void) => void: - Callback function (error: string | null, decryptedText?: string) => voidencrypt(plainText, callback)Encrypts text with the system secret key.
plainText string: - Plain text to encryptcallback (error: string | null | Error | undefined, encryptedText?: string) => void) => void: - Callback function (error: string | null, encryptedText?: string) => voidgetIsEasyModeStrict(callback)Get if the admin has easy mode enabled.
callback (error: string | null | Error | undefined, isEasyModeStrict?: boolean) => void) => void: - Callback function (error: string | null, isEasyModeStrict?: boolean) => voidgetEasyMode(callback)Get easy mode configuration.
callback (error: string | null | Error | undefined, easyModeConfig?: {strict: boolean; configs: InstanceConfig[]}) => void: - Callback function (error: string | null, easyModeConfig?: { strict: boolean; configs: InstanceConfig[] }) => voidgetAdapters(adapterName, callback)Get all adapter as objects.
adapterName string: - Optional adapter namecallback (error: string | null | Error | undefined, result?: ioBroker.AdapterObject[]) => void) => void: - Callback function (error: string | null, results?: ioBroker.Object[]) => voidupdateLicenses(login, password, callback)Read software licenses (vis, knx, ...) from ioBroker.net cloud for given user
login string: - Cloud loginpassword string: - Cloud passwordcallback (error: string | null | Error | undefined, result?: License[]) => void) => void: - Callback function (error: string | null, results?: License[]) => voidgetCompactInstances(callback)Get all instances in a compact form to save bandwidth.
callback (error: string | null | Error | undefined, result?: Record<string, CompactInstanceInfo>) => void) => void: - Callback function (error: string | null, results?: Record<string, { adminTab: boolean; name: string; icon: string; enabled: boolean }>) => voidgetCompactAdapters(callback)Get all adapters in a compact form to save bandwidth.
callback (error: string | null | Error | undefined, result?: Record<string, CompactAdapterInfo>) => void) => void: - Callback function (error: string | null, results?: Record<string, { icon: string; v: string; iv: string }>) => voidgetCompactInstalled(host, callback)Get all installed adapters in a compact form to save bandwidth.
host string: - Host name, e.g., system.host.raspberrypicallback (result?: Record<string, {version: string}>) => void) => void: - Callback function (error: string | null, results?: Record<string, { version: string }>) => voidgetCompactSystemConfig(callback)Get the system configuration in a compact form to save bandwidth.
callback (error: string | null | Error | undefined, systemConfig?: {common: ioBroker.SystemConfigCommon; native?: {secret: string; vendor?: any}}) => void: - Callback function (error: string | null, systemConfig?: { common: any; native?: { secret: string } }) => voidgetCompactSystemRepositories(callback)Get system repositories in a compact form to save bandwidth.
callback (error: string | null | Error | undefined, systemRepositories?: CompactSystemRepository) => void) => void: - Callback function (error: string | null, systemRepositories?: { common: any; native?: { repositories: Record<string, { json: { _repoInfo: any } } } } }) => voidgetCompactRepository(host, callback)Get the repository in a compact form to save bandwidth.
host string: - Host name, e.g., system.host.raspberrypicallback (result: Record<string, {version: string; icon?: string}>) => void) => void: - Callback function (error: string | null, results?: Record<string, { version: string; icon?: string }>) => voidgetCompactHosts(callback)Get all hosts in a compact form to save bandwidth.
callback (error: string | null | Error | undefined, hosts?: CompactHost[]) => void) => void: - Callback function (error: string | null, results?: Record<string, { common: { name: string; icon: string; color: string; installedVersion: string }; native: { hardware: { networkInterfaces: any[] } } }>) => voiddelState(id, callback?)Delete a state. The corresponding object will be deleted too.
id string: - State IDcallback? (error: string | null | Error | undefined) => void: - Callback function (error: string | null) => voidgetStates(pattern, callback)Get states by pattern of current adapter
pattern string | string[] | undefined: optional pattern, like system.adapter.* or array of state IDs. If the pattern is omitted, you will get ALL states of current adaptercallback (error: null | undefined | Error | string, states?: Record<string, ioBroker.State>) => void) => void: callback (error: null | undefined | Error | string, states?: Record<string, ioBroker.State>) => voidgetForeignStates(pattern, callback)Same as getStates
pattern string | string[]: pattern like system.adapter.* or array of state IDscallback (error: null | undefined | Error | string, states?: Record<string, ioBroker.State>) => void) => void: callback (error: null | undefined | Error | string, states?: Record<string, ioBroker.State>) => voidgetState(id, callback)Get a state by ID
id string: State ID, e.g. system.adapter.admin.0.memRsscallback (error: null | undefined | Error | string, state?: ioBroker.State) => void) => void: Callback (error: null | undefined | Error | string, state?: ioBroker.State) => voidsetState(id, state, callback)Set a state by ID
id string: State ID, e.g. system.adapter.admin.0.memRssstate ioBroker.SettableState: State value or object, e.g. {val: 123, ack: true}callback (error: null | undefined | Error | string, state?: ioBroker.State) => void) => void: Callback (error: null | undefined | Error | string, state?: ioBroker.State) => voidgetBinaryState(id, callback)Get a binary state by ID
id string: State ID, e.g. javascript.0.binarycallback (error: null | undefined | Error | string, base64?: string) => void) => void: Callback (error: null | undefined | Error | string, base64?: string) => voidsetBinaryState(id, _base64, callback)Set a binary state by ID
id string: State ID, e.g. javascript.0.binary_base64 string: State value as base64 string. Binary states have no acknowledged flag.callback (error: null | undefined | Error | string) => void) => void: Callback (error: null | undefined | Error | string) => voidsubscribe(pattern, callback)Subscribe to state changes by pattern. The events will come as 'stateChange' events to the socket.
pattern string | string[]: Pattern like system.adapter.* or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']callback (error: string | null) => void) => void: Callback (error: string | null) => voidsubscribeStates(pattern, callback)Subscribe to state changes by pattern. Same as subscribe.
The events will come as 'stateChange' events to the socket.
pattern string | string[]: Pattern like system.adapter.* or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']callback (error: string | null) => void) => void: Callback (error: string | null) => voidunsubscribe(pattern, callback)Unsubscribe from state changes by pattern.
pattern string | string[]: Pattern like system.adapter.* or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']callback (error: string | null) => void) => void: Callback (error: string | null) => voidunsubscribeStates(pattern, callback)Unsubscribe from state changes by pattern. Same as unsubscribe.
The events will come as 'stateChange' events to the socket.
pattern string | string[]: Pattern like system.adapter.* or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']callback (error: string | null) => void) => void: Callback (error: string | null) => voidaddUser(user, pass, callback?)Add a new user.
user string: - User name, e.g., benjaminpass string: - User passwordcallback? (error: string | null | Error | undefined) => void: - Callback function (error: string | null) => voiddelUser(user, callback?)Delete an existing user. Admin cannot be deleted.
user string: - User name, e.g., benjamincallback? (error: string | null | Error | undefined) => void: - Callback function (error: string | null) => voidaddGroup(group, desc, acl, callback?)Add a new group.
group string: - Group name, e.g., usersdesc ioBroker.StringOrTranslated | null: - Optional descriptionacl Omit<ioBroker.PermissionSet, 'user' | 'groups'> | null: - Optional access control list object, e.g., {"object":{"list":true,"read":true,"write":false,"delete":false},"state":{"list":true,"read":true,"write":true,"create":true,"delete":false},"users":{"list":true,"read":true,"write":false,"create":false,"delete":false},"other":{"execute":false,"http":true,"sendto":false},"file":{"list":true,"read":true,"write":false,"create":false,"delete":false}}callback? (error: string | null | Error | undefined) => void: - Callback function (error: string | null) => voiddelGroup(group, callback?)Delete an existing group. Administrator group cannot be deleted.
group string: - Group name, e.g., userscallback? (error: string | null | Error | undefined) => void: - Callback function (error: string | null) => voidchangePassword(user, pass, callback?)Change user password.
user string: - User name, e.g., benjaminpass string: - New passwordcallback? (error: string | null | Error | undefined) => void: - Callback function (error: string | null) => voidgetObject(id, callback)Get one object.
id string: Object IDcallback (error: Error | undefined | string | null, obj?: ioBroker.Object) => void) => void: Callback (error: string | null, obj?: ioBroker.Object) => voidgetObjects(list, callback)Get all objects that are relevant for web: all states and enums with rooms. This is non-admin version of "all objects" and will be overloaded in admin
list string[] | null: Optional list of IDscallback (error: Error | undefined | string | null, objs?: Record<string, ioBroker.Object>) => void) => void: Callback (error: string | null, objs?: Record<string, ioBroker.Object>) => voidsubscribeObjects(pattern, callback)Subscribe to object changes by pattern. The events will come as 'objectChange' events to the socket.
pattern string | string[]: Pattern like system.adapter.* or array of IDs like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']callback (error: Error | undefined | string | null) => void) => void: Callback (error: string | null) => voidunsubscribeObjects(pattern, callback)Unsubscribe from object changes by pattern.
pattern string | string[]: Pattern like system.adapter.* or array of IDs like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']callback (error: string | null | Error | undefined) => void) => void: Callback (error: string | null) => voidgetObjectView(design, search, params, callback)Get a view of objects. Make a query to the object database.
design string: Design name, e.g., 'system' or other designs like custom, but it must exist object _design/custom. To 99,9% use system.search string: Search name, object type, like state, instance, adapter, host, ...params {startkey?: string; endkey?: string; depth?: number}: Parameters for the query, e.g., {startkey: 'system.adapter.', endkey: 'system.adapter.\u9999', depth?: number}callback (error: string | null | Error | undefined, result?: {rows: {id: string; value: ioBroker.Object & {virtual: boolean; hasChildren: number;};}[];}) => void: Callback (error: string | null, result?: { rows: Array<GetObjectViewItem> }) => voidsetObject(id, obj, callback)Set an object.
id string: Object IDobj ioBroker.Object: Object to setcallback (error: string | null | Error | undefined) => void) => void: Callback (error: string | null) => voiddelObject(id, _options, callback)Delete an object. Only deletion of flot and fullcalendar objects is allowed
id string: Object ID, like 'flot.0.myChart'_options any: Options for deletion. Ignoredcallback (error: string | null | Error | undefined) => void) => void: Callback (error: string | null) => voidgetAllObjects(callback)Read absolutely all objects.
callback (error: null | undefined | Error | string, result?: Record<string, ioBroker.Object>) => void) => void: - Callback function (error: string | null, objects?: Record<string, ioBroker.Object>) => voidextendObject(id, obj, callback?)Extend the existing object.
id string: - Object IDobj Partial<ioBroker.Object>: - New parts of the object, e.g., {common: {name: 'new name'}}callback? (error: string | null | Error | undefined) => void: - Callback function (error: string | null) => voidgetForeignObjects(pattern, type, callback?)Read objects by pattern.
pattern string: - Pattern like system.adapter.admin.0.*type * ioBroker.ObjectType | undefined | ((error: string | null | Error | undefined, objects?: Record<string, ioBroker.Object>) => void)*: - Type of objects to delete, like state, channel, device, host, adapter. Default - statecallback? (error: string | null | Error | undefined, objects?: Record<string, ioBroker.Object>) => void: - Callback function (error: string | null, objects?: Record<string, ioBroker.Object>) => voiddelObjects(id, options?, callback?)Delete an object or objects recursively.
Objects with dontDelete cannot be deleted.
Same as delObject but with recursive: true.
id string: - Object ID, like 'adapterName.0.channel'options? ioBroker.DelObjectOptions | ((error: string | null | Error | undefined) => void) | null: - Options for deletion.callback? (error: string | null | Error | undefined) => void: - Callback function (error: string | null) => voidreadFile(adapter, fileName, callback)Read a file from ioBroker DB
adapter string: instance name, e.g. vis.0fileName string: file name, e.g. main/vis-views.jsoncallback (error: null | undefined | Error | string, data: Buffer | string, mimeType: string) => void) => void: Callback (error: null | undefined | Error | string, data: Buffer | string, mimeType: string) => voidreadFile64(adapter, fileName, callback)Read a file from ioBroker DB as base64 string
adapter string: instance name, e.g. vis.0fileName string: file name, e.g. main/vis-views.jsoncallback (error: null | undefined | Error | string, base64?: string, mimeType?: string) => void) => void: Callback (error: null | undefined | Error | string, base64: string, mimeType: string) => voidwriteFile64(adapter, fileName, data64, options, callback?)Write a file into ioBroker DB as base64 string
adapter string: instance name, e.g. vis.0fileName string: file name, e.g. main/vis-views.jsondata64 string: file content as base64 stringoptions {mode?: number} | ((error: null | undefined | Error | string) => void): optional {mode: 0x0644}callback? (error: null | undefined | Error | string) => void: Callback (error: null | undefined | Error | string) => voidwriteFile(adapter, fileName, data, options, callback?)Write a file into ioBroker DB as text This function is overloaded in admin (because admin accepts only base64)
adapter string: instance name, e.g. vis.0fileName string: file name, e.g. main/vis-views.jsondata string: file content as textoptions {mode?: number} | ((error: null | undefined | Error | string) => void): optional {mode: 0x0644}callback? (error: null | undefined | Error | string) => void: Callback (error: null | undefined | Error | string) => voidunlink(adapter, name, callback)Delete file in ioBroker DB
adapter string: instance name, e.g. vis.0name string: file name, e.g. main/vis-views.jsoncallback (error: null | undefined | Error | string) => void) => void: Callback (error: null | undefined | Error | string) => voiddeleteFile(adapter, name, callback)Delete a file in ioBroker DB (same as "unlink", but only for files)
adapter string: instance name, e.g. vis.0name string: file name, e.g. main/vis-views.jsoncallback (error: null | undefined | Error | string) => void) => void: Callback (error: null | undefined | Error | string) => voiddeleteFolder(adapter, name, callback)Delete folder in ioBroker DB (same as unlink, but only for folders)
adapter string: instance name, e.g. vis.0name string: folder name, e.g. maincallback (error: null | undefined | Error | string) => void) => void: Callback (error: null | undefined | Error | string) => voidrenameFile(adapter, oldName, newName, callback)Rename a file in ioBroker DB
adapter string: instance name, e.g. vis.0oldName string: current file name, e.g. main/vis-views.jsonnewName string: new file name, e.g. main/vis-views-new.jsoncallback (error: null | undefined | Error | string) => void) => void: Callback (error: null | undefined | Error | string) => voidrename(adapter, oldName, newName, callback)Rename file or folder in ioBroker DB
adapter string: instance name, e.g. vis.0oldName string: current file name, e.g. main/vis-views.jsonnewName string: new file name, e.g. main/vis-views-new.jsoncallback (error: null | undefined | Error | string) => void) => void: Callback (error: null | undefined | Error | string) => voidmkdir(adapter, dirName, callback)Create a folder in ioBroker DB
adapter string: instance name, e.g. vis.0dirName string: desired folder name, e.g. maincallback (error: null | undefined | Error | string) => void) => void: Callback (error: null | undefined | Error | string) => voidreadDir(adapter, dirName, options, callback?)Read content of folder in ioBroker DB
adapter string: instance name, e.g. vis.0dirName string: folder name, e.g. mainoptions object | ((error: null | undefined | Error | string, files: ioBroker.ReadDirResult[]) => void): for future usecallback? (error: null | undefined | Error | string, files: ioBroker.ReadDirResult[]) => void: Callback (error: null | undefined | Error | string, files: Array<{file: string, isDir: boolean, stats: {size: number}, modifiedAt: number, acl: {owner: string, ownerGroup: string, permissions: number, read: boolean, write: boolean}}>) => voidchmodFile(adapter, fileName, options, callback?)Change a file mode in ioBroker DB
adapter string: instance name, e.g. vis.0fileName string: file name, e.g. main/vis-views.jsonoptions {mode?: number}: options {mode: 0x644}callback? (error: string | Error | null | undefined) => void: Callback (error: string | Error | null | undefined) => voidchownFile(adapter, fileName, options, callback?)Change file owner in ioBroker DB
adapter string: instance name, e.g. vis.0fileName string: file name, e.g. main/vis-views.jsonoptions {owner: system.user.${string}; ownerGroup?: system.group.${string}}: options {owner: 'system.user.user', ownerGroup: 'system.group.administrator'} or system.user.user. If ownerGroup is not defined, it will be taken from owner.callback? (error: null | undefined | Error | string) => void: Callback (error: null | undefined | Error | string) => voidfileExists(adapter, fileName, callback)Check if the file or folder exists in ioBroker DB
adapter string: instance name, e.g. vis.0fileName string: file name, e.g. main/vis-views.jsoncallback (error: null | undefined | Error | string, exists?: boolean) => void) => void: Callback (error: null | undefined | Error | string, exists?: boolean) => voidsubscribeFiles(id, pattern, callback)Subscribe to file changes in ioBroker DB
id string: instance name, e.g. vis.0 or any object ID of type meta. id could have wildcards * too.pattern string | string[]: file name pattern, e.g. main/*.json or array of namescallback (error: null | undefined | Error | string) => void) => void: Callback (error: null | undefined | Error | string) => voidunsubscribeFiles(id, pattern, callback)Unsubscribe from file changes in ioBroker DB
id string: instance name, e.g. vis.0 or any object ID of type meta. id could have wildcards * too.pattern string | string[]: file name pattern, e.g. main/*.json or array of namescallback (error: null | undefined | Error | string) => void) => void: Callback (error: null | undefined | Error | string) => voidinfo.connectedreauthenticate command if token expiredSocketAdmingetCompactSystemConfig commandgetCompactInstancesmethod with version informationadapter-core versionpublishInstanceMessageAll commandnamejson5 as jsongetObjectsfor web was extended by devices, channels and enumsdelObjects methodgetCompactSystemRepositoriespassportwriteDirAsZipwriteDirAsZip locallygetObjects commanddelObjects commanddelObject commandThe MIT License (MIT)
Copyright (c) 2020-2025 @GermanBluefox dogafox@gmail.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
ioBroker server-side web sockets
The npm package @iobroker/socket-classes receives a total of 2,087 weekly downloads. As such, @iobroker/socket-classes popularity was classified as popular.
We found that @iobroker/socket-classes demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Following last week’s supply chain attack, Nx published findings on the GitHub Actions exploit and moved npm publishing to Trusted Publishers.
Security News
AGENTS.md is a fast-growing open format giving AI coding agents a shared, predictable way to understand project setup, style, and workflows.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.