https://github.com/frdteknikelektro/MMM-SimpleLogo

MagicMirror Modules Simple Logo
https://github.com/frdteknikelektro/MMM-SimpleLogo

image logo magic-mirror-modules magicmirror simple

Last synced: 22 days ago
JSON representation

MagicMirror Modules Simple Logo

• Host: GitHub
• URL: https://github.com/frdteknikelektro/MMM-SimpleLogo
• Owner: frdteknikelektro
• License: mit
• Created: 2016-12-25T03:18:33.000Z (almost 8 years ago)
• Default Branch: develop
• Last Pushed: 2024-03-26T14:26:26.000Z (9 months ago)
• Last Synced: 2024-08-04T10:03:12.198Z (4 months ago)
• Topics: image, logo, magic-mirror-modules, magicmirror, simple
• Language: JavaScript
• Size: 22.5 KB
• Stars: 39
• Watchers: 6
• Forks: 20
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-mmm - **MMM-SimpleLogo**

README

        
# Module: MMM-SimpleLogo

The `MMM-SimpleLogo` module is third party modules of the MagicMirror. This module simply displays logo.

## Using the module

To use this module, add it to the modules array in the `config/config.js` file:

```javascript

modules: [

    {

        module: 'MMM-SimpleLogo',

        position: 'top_left',    // This can be any of the regions.

        config: {

            // The config property is optional.

            // See 'Configuration options' for more information.

        }

    }

]

```

## Configuration options

The following properties can be configured:

	

	

		

			Option

			Description

		

	

	

		

			fileUrl

			File url.


				
Possible values: Logo link form internet or path to your local files relative to MagicMirror directory

				
Default value: 'modules/MMM-SimpleLogo/public/logo.png'

			

		

		

			width

			Set width of your logo, height is auto.


				
Possible values: '300px' or '50%'

				
Default value: '200px'

			

		

		

			position

			Horizontal position on current container


				
Possible values: left, center, or right

				
Default value: left

			

		

		

			refreshInterval

			Refresh/refetch image file between interval. Only use this if your image url return different image after some interval of time, even the fileUrl is not changed. See this case #2, awesome project by @ElYoM 


				
Possible values: 1000, 2000, or 10000

				
Default value: 0 (disabled)

			

		

		

			text

			Text above the image.


				
Possible values: Any text

				
Default value: Simple Logo

			

		

	

## Notification Events

The MMM-SimpleLogo module supports the notification event `SIMPLE_LOGO_UPDATE` which allows the configuration to be dynamically modified.  As an example, the MMM-OnScreenMenu module might be used to dynamic adjust the `fileURL` parameter as follows:

    {

        module: "MMM-OnScreenMenu",

        position: "top_left",

        config: {

            menuItems: {

                notify1: {

                    title: "Show Cat",

                    notification: "SIMPLE_LOGO_UPDATE",

                    payload: {

                        fileUrl: "cat.jpg",

                        width: "750px"

                    }

                },

                notify2: {

                    title: "Show Dog",

                    notification: "SIMPLE_LOGO_UPDATE",

                    payload: {

                        fileUrl: "dog.jpg",

                        width: "1050px"

                    }

                }

            }

        }

    }