Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Index your code
hub
/
github.com/alexryd/homebridge-shelly-ng
/ functions
Functions
148 in github.com/alexryd/homebridge-shelly-ng
⨍
Functions
148
◇
Types & classes
78
↓ 21 callers
Method
debug
(message: string, ...parameters: unknown[])
src/utils/device-logger.ts:31
↓ 17 callers
Method
setActive
* Sets `active` to the given value. * This method can be used when chaining calls, as it returns a reference to `this`. * @param value - Whether
src/accessory.ts:91
↓ 12 callers
Method
error
(message: string, ...parameters: unknown[])
src/utils/device-logger.ts:27
↓ 10 callers
Method
set
* Stores the given device info. * @param d - The device info. * @param autoSave - Whether `saveDelayed()` should be automatically invoked.
src/utils/device-cache.ts:136
↓ 7 callers
Method
info
(message: string, ...parameters: unknown[])
src/utils/device-logger.ts:19
↓ 5 callers
Method
delete
* Deletes info about the device with the given ID from cache. * @param id - The device ID. * @param autoSave - Whether `saveDelayed()` should be
src/utils/device-cache.ts:173
↓ 5 callers
Method
get
* Returns device info for the given device ID.
src/utils/device-cache.ts:127
↓ 4 callers
Method
detach
()
src/abilities/cover.ts:85
↓ 4 callers
Method
log
(level: LogLevel, message: string, ...parameters: unknown[])
src/utils/device-logger.ts:35
↓ 4 callers
Method
update
* Updates this accessory based on whether it is active.
src/accessory.ts:99
↓ 3 callers
Method
triggerPress
* Triggers a button press event. * @param type - The type of button press to trigger.
src/abilities/stateless-programmable-switch.ts:51
↓ 2 callers
Method
removeAccessory
* Removes one or more platform accessories from this platform. * This method will also unregister the accessories from homebridge. * @param acce
src/platform.ts:240
↓ 2 callers
Method
saveDelayed
* Saves the devices to cache after a short delay. * Multiple calls to this method within the delay will be debounced.
src/utils/device-cache.ts:104
↓ 2 callers
Method
setup
()
src/device-delegates/shelly-pro-3.ts:9
↓ 2 callers
Method
warn
(message: string, ...parameters: unknown[])
src/utils/device-logger.ts:23
↓ 1 callers
Method
activate
* Activates this accessory, by creating a platform accessory and setting up all abilities.
src/accessory.ts:122
↓ 1 callers
Method
addAccessory
* Adds one or more platform accessories to this platform. * This method will also register the accessories with homebridge. * @param accessories
src/platform.ts:213
↓ 1 callers
Function
createCharacteristics
(api: API)
src/utils/characteristics.ts:16
↓ 1 callers
Method
createPlatformAccessory
* Creates a new platform accessory for this accessory.
src/accessory.ts:176
↓ 1 callers
Function
createServices
(api: API, characteristics: CustomCharacteristics)
src/utils/services.ts:16
↓ 1 callers
Method
deactivate
* Deactivates this accessory, by destroying all abilities and the platform accessory.
src/accessory.ts:150
↓ 1 callers
Method
emitDevice
* Emits a device after the configured time interval has passed.
src/platform.ts:66
↓ 1 callers
Method
emitDevice
* Emits a device after the configured time interval has passed.
src/platform.ts:104
↓ 1 callers
Method
getAccessory
* Returns the platform accessory with the given UUID. * @param uuid - The UUID.
src/platform.ts:204
↓ 1 callers
Method
getDeviceOptions
* Return the configuration options for the device with the given ID. * If no options have been specified, default values will be returned. * @pa
src/config.ts:178
↓ 1 callers
Method
handleUnknownDevice
* Handles 'unknown' events from the shellies-ng library.
src/platform.ts:425
↓ 1 callers
Method
initialize
()
src/abilities/cover.ts:61
↓ 1 callers
Method
load
* Loads cached devices.
src/utils/device-cache.ts:61
↓ 1 callers
Method
run
* Runs this discoverer.
src/platform.ts:51
↓ 1 callers
Method
run
* Runs this discoverer.
src/platform.ts:91
↓ 1 callers
Method
runCacheDeviceDiscoverer
* Discovers all devices found in cache.
src/platform.ts:300
↓ 1 callers
Method
runConfigDeviceDiscoverer
* Discovers all devices found in the configuration.
src/platform.ts:288
↓ 1 callers
Method
save
* Saves the devices to cache.
src/utils/device-cache.ts:89
↓ 1 callers
Method
startMdnsDeviceDiscovery
* Starts device discovery over mDNS.
src/platform.ts:312
↓ 1 callers
Method
storeDevice
* Stores info about the given device in cache. * @param device - The device. * @param autoSave - Whether `saveDelayed()` should be automatically
src/utils/device-cache.ts:149
Function
Characteristic
* Shorthand property.
src/abilities/base.ts:55
Function
Service
* Shorthand property.
src/abilities/base.ts:62
Method
[Symbol.iterator]
* Returns a new Iterator object that contains each device.
src/utils/device-cache.ts:184
Function
active
* Whether this ability is active. * Setting an ability to inactive will remove its HomeKit service.
src/abilities/base.ts:110
Method
active
* Whether this accessory is active. * Setting an accessory to inactive will remove it from HoneKit.
src/accessory.ts:41
Function
addCover
* Creates an accessory for a cover component. * @param cover - The cover component to use. * @param opts - Options for the cover.
src/device-delegates/base.ts:206
Function
addService
* Returns a service for this ability. * If the platform accessory has a matching service, it will be returned. Otherwise, the service will be added
src/abilities/base.ts:198
Function
addSwitch
* Creates an accessory for a switch component. * @param swtch - The switch component to use. * @param opts - Options for the switch.
src/device-delegates/base.ts:178
Method
aenergyChangeHandler
* Handles changes to the `aenergy` property.
src/abilities/power-meter.ts:119
Function
api
* A reference to the homebridge API.
src/abilities/base.ts:48
Method
apowerChangeHandler
* Handles changes to the `apower` property.
src/abilities/power-meter.ts:89
Method
apowerChangeHandler
* Handles changes to the `apower` property.
src/abilities/outlet.ts:78
Method
configureAccessory
* Configures cached accessories. * This method is invoked once for each cached accessory that is loaded during launch.
src/platform.ts:195
Function
constructor
* @param serviceName - A name of the service. * @param serviceSubtype - A unique identifier for the service.
src/abilities/base.ts:127
Function
constructor
* @param device - The device to handle. * @param options - Configuration options for the device. * @param platform - A reference to the homebrid
src/device-delegates/base.ts:107
Method
constructor
* @param options - The platform configuration options. * @param emitInterval - The interval, in milliseconds, to wait between each emitted device.
src/platform.ts:44
Method
constructor
* @param deviceCache - The cached devices. * @param emitInterval - The interval, in milliseconds, to wait between each emitted device.
src/platform.ts:84
Method
constructor
* This constructor is invoked by homebridge. * @param log - A logging device for this platform. * @param config - Configuration options for this
src/platform.ts:160
Method
constructor
* @param id - The accessory ID. * @param deviceId - The associated device ID. * @param name - A user-friendly name of the accessory. * @param
src/accessory.ts:67
Method
constructor
* @param config - The platform configuration.
src/config.ts:144
Method
constructor
()
src/utils/characteristics.ts:23
Method
constructor
()
src/utils/characteristics.ts:41
Method
constructor
()
src/utils/characteristics.ts:59
Method
constructor
()
src/utils/characteristics.ts:77
Method
constructor
* @param device - The device to use. * @param deviceName - A user-friendly name of the device. * @param logger - The logging device to write to.
src/utils/device-logger.ts:15
Method
constructor
* @param storagePath - A path to the directory that the devices will be stored in. * @param log - A logging device.
src/utils/device-cache.ts:54
Method
constructor
(displayName?: string, subtype?: string)
src/utils/services.ts:23
Method
constructor
* @param component - The switch component to control.
src/abilities/switch.ts:10
Method
constructor
* @param component - The input component to represent.
src/abilities/readonly-switch.ts:14
Method
constructor
* @param component - The switch or cover component to get readings from.
src/abilities/power-meter.ts:17
Method
constructor
* @param component - The cover component to control.
src/abilities/cover.ts:16
Method
constructor
* @param component - The input component to control.
src/abilities/stateless-programmable-switch.ts:15
Method
constructor
* @param component - The switch component to control.
src/abilities/outlet.ts:10
Method
constructor
* @param namespace - The naming schema for the accessory.
src/abilities/service-label.ts:7
Method
constructor
* @param device - The associated device.
src/abilities/accessory-information.ts:12
Function
createAccessory
* Creates an accessory with the given ID. * If a matching platform accessory is not found in cache, a new one will be created. * @param id - A u
src/device-delegates/base.ts:145
Method
currentChangeHandler
* Handles changes to the `current` property.
src/abilities/power-meter.ts:109
Method
currentPosChangeHandler
* Handles changes to the `current_pos` property.
src/abilities/cover.ts:122
Method
currentPosition
* The current position of the cover.
src/abilities/cover.ts:50
Function
customCharacteristics
* Shorthand property.
src/abilities/base.ts:69
Function
customServices
* Shorthand property.
src/abilities/base.ts:76
Function
destroy
* Removes all event listeners and all references to the platform accessory. * This method is called by the parent accessory every time it becomes i
src/abilities/base.ts:265
Function
destroy
* Destroys this device delegate, removing all event listeners and unregistering all accessories.
src/device-delegates/base.ts:284
Function
detach
* Removes all event listeners from this device.
src/device-delegates/base.ts:269
Method
detach
* Removes all event listeners from this accessory.
src/accessory.ts:194
Method
detach
()
src/abilities/switch.ts:36
Method
detach
()
src/abilities/readonly-switch.ts:38
Method
detach
()
src/abilities/power-meter.ts:78
Method
detach
()
src/abilities/stateless-programmable-switch.ts:40
Method
detach
()
src/abilities/outlet.ts:42
Method
detach
()
src/abilities/service-label.ts:25
Method
detach
()
src/abilities/accessory-information.ts:29
Method
doublePushHandler
* Handles 'doublePush' events from our input component.
src/abilities/stateless-programmable-switch.ts:87
Function
getComponentOptions
* Retrieves configuration options for the given component from the device options. * @param component - The component. * @returns A set of optio
src/device-delegates/base.ts:134
Function
getDelegate
* Returns the device delegate for the given device class or model, if one has been registered. * @param deviceClsOrModel - The device class or mode
src/device-delegates/base.ts:82
Method
handleAddedDevice
* Handles 'add' events from the shellies-ng library.
src/platform.ts:340
Function
handleConnect
* Handles 'connect' events from the RPC handler.
src/device-delegates/base.ts:230
Function
handleDisconnect
* Handles 'disconnect' events from the RPC handler.
src/device-delegates/base.ts:238
Method
handleError
* Handles 'error' events from the shellies-ng library.
src/platform.ts:432
Method
handleExcludedDevice
* Handles 'exclude' events from the shellies-ng library.
src/platform.ts:389
Method
handleRemovedDevice
* Handles 'remove' events from the shellies-ng library.
src/platform.ts:377
Function
handleRequest
* Handles 'request' events from the RPC handler.
src/device-delegates/base.ts:262
Method
initialize
* Initializes this platform.
src/platform.ts:257
Method
initialize
()
src/abilities/switch.ts:21
Method
initialize
()
src/abilities/readonly-switch.ts:25
next →
1–100 of 148, ranked by callers