Package: ovos-PHAL-plugin-wallpaper-manager
OVOS PHAL PLUGIN WALLPAPER MANAGERThis PHAL plugin provides a central wallpaper management interface for homescreens and other desktopsPlatform support provided byhttps://github.com/OpenVoiceOS/wallpaper_changerWhat is the Wallpaper Management Interface ?The wallpaper management interface provides functionality for providing a central interface for homescreen and desktop wallpaper management, this interface is responsible for providing a list of available wallpapers and also provides functionality for setting a wallpaper from the list of available wallpapers. This interface supports different types of wallpaper providers, this can be a local provider that provides wallpapers from the local filesystem or a remote provider that provides wallpapers from a remote url.Installpip install ovos-PHAL-plugin-wallpaper-managerEvent & API Details and Usage:Registration / Activation of Wallpaper Providers APIWallpaper providers are required to register themselves with the central wallpaper management interface, this is done by sending the following event:# ovos.wallpaper.manager.register.provider# type: Request# description: Register a wallpaper provider to the plugin# data required:# provider_name = typically the self.skill_id of the skill that provides the wallpaper provider# provider_display_name = A display name for the wallpaper provider, that will be displayed on the selection screens# (optional) provider_configurable = True if the wallpaper provider is configurable, False if notOn successful registration of a wallpaper provider, the wallpaper management interface will respond with the following event:# ovos.phal.wallpaper.manager.provider.registered# type: Response# description: Registration successfulActivate a wallpaper provider by sending the following event:# ovos.wallpaper.manager.set.active.provider# type: Request# description: Activate a wallpaper provider# data required:# provider_name = typically the self.skill_id of the skill that is the wallpaper providerNote: This is handled by the Wallpapers Settings UI on "smartspeaker" and "mobile" GUI platforms,
Skills / Wallpaper providers must not be sending this unless they want to force override the currently set provider.Wallpaper Collection APIA wallpaper provider can send a collection of wallpapers to the wallpaper management interface, this is optional and will depend on case by case basis, where some providers might have their own collection of wallpapers and some
might not and depend on an online source for wallpapers.After registration of a wallpaper provider, the wallpaper management interface will send an event to the wallpaper provider to request a collection of wallpapers, Any provider wanting to provide wallpapers can do so by listening for the following signal:# {provider_name}.get.wallpaper.collection# type: Request# description: Request a collection of wallpapers from the wallpaper providerand responding to the above signal by sending the following event:# ovos.wallpaper.manager.collect.collection.response# type: Response# description: Response to the wallpaper collection request# data required:# provider_name = typically the self.skill_id of the skill that provides the wallpaper provider# wallpaper_collection = a list of full wallpaper paths that are available from the wallpaper providerthe wallpaper provider can also ask the wallpaper management interface to update its wallpaper collection by sending the following event at any time:# ovos.wallpaper.manager.update.collection# type: Request# description: Request the wallpaper management interface to update its wallpaper collection# data required:# provider_name = typically the self.skill_id of the skill that provides the wallpaper providerWallpaper Request For Non Collection Providers APIIf a wallpaper provider does not provide a collection of wallpapers, the wallpaper management interface will always send an event to the wallpaper provider to request for a new wallpaper, The wallpaper provider must listen for the following signal:# {provider_name}.get.new.wallpaper# type: Request# description: Request a new wallpaper from the wallpaper providerThe wallpaper provider must respond to the above signal by sending the following event:# ovos.wallpaper.manager.set.wallpaper# type: Response# description: Response to the wallpaper request to set new wallpaper# data required:# url = the full path of the wallpaper that is to be setGet and Set Wallpaper APIThe wallpaper management interface provides functionality for getting and setting wallpapers, the wallpaper management interface will send the following event to get the current wallpaper:# ovos.wallpaper.manager.get.wallpaper# type: Request# description: Request the wallpaper management interface to get the current wallpaperThe wallpaper management interface will respond to the above event with the following event:# ovos.wallpaper.manager.get.wallpaper.response# type: Response# description: Response to the wallpaper request to get the current wallpaper# data sent:# url = the full path of the current wallpaperTo set a wallpaper, the wallpaper management interface can be sent the following event:# ovos.wallpaper.manager.set.wallpaper# type: Request# description: Request the wallpaper management interface to set a new wallpaper# data required:# url = the full path of the wallpaper that is to be setNote:For platforms where homescreens are supported the above event will cause the wallpaper management interface will set the homescreen wallpaper.For non homescreen platforms like the desktop, the above event will cause the wallpaper management interface to set the desktop wallpaper.Change Wallpapers APIAny skill / event can request the wallpaper management interface to change the wallpaper by sending the following event:# ovos.wallpaper.manager.change.wallpaper# type: Request# description: Request the wallpaper management interface to change the wallpaperNote:If the selected provider provides a collection of wallpapers, the wallpaper management interface will select the next wallpaper from the collection and set it as the wallpaper.If the selected provider does not provide a collection of wallpapers, the wallpaper management interface will send a request to the provider to get a new wallpaper.AutoRotate Wallpapers APIThe wallpaper management interface provides functionality for automatically rotating wallpapers, this is done by sending the following event:# ovos.wallpaper.manager.enable.auto.rotation# type: Request# description: Request the wallpaper management interface to enable auto rotate and set an wallpaper rotation interval# data required:# rotation_time = the time in seconds at which the wallpapers should be rotatedWallpaper auto rotation can be disabled by sending the following event:# ovos.wallpaper.manager.disable.auto.rotation# type: Request# description: Request the wallpaper management interface to disable auto rotateProvider Configuration APIThe wallpaper management interface provides functionality for configuring wallpaper providers through the GUI interface, this is the event providers must listen for:Note: Currently only string configuration options are supported.# {provider_name}.get.wallpaper.config# type: Request# description: Request the wallpaper management interface to configure a wallpaper provideron receiving the above event, the wallpaper provider must respond with the following event:# ovos.wallpaper.manager.provider.config# type: Response# description: Response to the wallpaper provider configuration request# data required:# provider_name = typically the self.skill_id of the skill that provides the wallpaper provider# config = a dictionary of configuration options for the wallpaper providerExample Implementation in a Wallpaper Provider Skill Providing a Collection of Wallpapers:defExampleWallpaperProvider(OVOSSkill):def__init__(self):super(ExampleWallpaperProvider,self).__init__(name="ExampleWallpaperProvider")self.wallpaper_collection=[]definitialize(self):self.bus.on("ovos.wallpaper.manager.loaded",self.register_with_wallpaper_provider)self.bus.on(f"{self.skill_id}.get.wallpaper.collection",self.supply_wallpaper_collection)defcollect_wallpapers(self):wallpaper_folder="/usr/share/wallpapers"fordirname,dirnames,filenamesinos.walk(wallpaper_folder):self.wallpaper_collection=filenamespassdefregister_with_wallpaper_provider(self,message):self.bus.emit(Message("ovos.wallpaper.manager.register.provider",data={"provider_name":self.skill_id,"provider_display_name":"Example Wallpaper Provider"}))defsupply_wallpaper_collection(self,message):self.collect_wallpapers()self.bus.emit(Message("ovos.wallpaper.manager.collect.collection.response",data={"provider_name":self.skill_id,"wallpaper_collection":self.wallpaper_collection}))Example Implementation in a Wallpaper Provider Skill Not Providing a Collection of Wallpapers:defExampleWallpaperProvider(OVOSSkill):def__init__(self):super(ExampleWallpaperProvider,self).__init__(name="ExampleWallpaperProvider")self.wallpaper_collection=[]definitialize(self):self.bus.on("ovos.wallpaper.manager.loaded",self.register_with_wallpaper_provider)self.bus.on(f"{self.skill_id}.get.new.wallpaper",self.supply_new_wallpaper)defregister_with_wallpaper_provider(self,message):self.bus.emit(Message("ovos.wallpaper.manager.register.provider",data={"provider_name":self.skill_id,"provider_display_name":"Example Wallpaper Provider"}))defsupply_new_wallpaper(self,message):# Get a new wallpaper from some online source# and set it as the wallpaper on every request for a new wallpaperurl="https://example.com/wallpaper.jpg"self.bus.emit(Message("ovos.wallpaper.manager.set.wallpaper",data={"url":url}))