Merge branch 'master' into development

Author: Lbork45

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Set config to '...'
+2. Run or send notification '...'
+3. See error '...'
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**System (please complete the following information):**
+ - OS: [e.g. Raspberry Pi OS]
+
+**Additional context**
+Add any other context about the problem here.

MMM-StyledSlideshow.js

@@ -4,7 +4,7 @@ Module.register("MMM-StyledSlideshow", {
     imageFolder: "example_images",
     scrollInterval: 30000,
     width: 20,
-    height: 20
+    height: 20,
   },
 
   start() {
@@ -38,8 +38,9 @@ Module.register("MMM-StyledSlideshow", {
 getDom() {
   const wrapper = document.createElement("div");
   const image = document.createElement("img");
-  image.style.width = this.width + "%"
-  image.style.height = this.height + "%"
+  image.style.width = this.width + "%";
+  image.style.height = this.height + "%";
+  image.style.objectFit = "cover";
   image.src = this.file(this.imagePath);
   image.alt = this.imagePath + " error loading";
   wrapper.appendChild(image);
@@ -53,6 +54,11 @@ getDom() {
     console.log("[MMM-StyledSlideshow] - Changing Image")
   },
 
+  refresh() {
+    this.sendSocketNotification("GET_PATHS", this.imageFolder)
+    this.updateDom(10000)
+  },
+
   /**
    * This is the place to receive notifications from other modules or the system.
    *

README.md

@@ -1,9 +1,13 @@
 # MMM-StyledSlideshow
 
+*MMM-StyledSlideshow* is a module for [MagicMirror²](https://github.com/MagicMirrorOrg/MagicMirror) that displays a slideshow of images at a regular interval.
+# MMM-StyledSlideshow
+
 *MMM-StyledSlideshow* is a module for [MagicMirror²](https://github.com/MagicMirrorOrg/MagicMirror) that displays a slideshow of images at a regular interval.
 
 ## Screenshot
 
+![Example of MMM-StyledSlideshow](./example_1.png)
 ![Example of MMM-StyledSlideshow](./example_1.png)
 
 ## Installation
@@ -15,6 +19,7 @@ In your terminal, go to the modules directory and clone the repository:
 ```bash
 cd ~/MagicMirror/modules
 git clone https://github.com/Lbork45/MMM-StyledSlideshow.git
+git clone https://github.com/Lbork45/MMM-StyledSlideshow.git
 ```
 
 ### Update
@@ -38,13 +43,17 @@ Minimal configuration to use the module:
     {
         module: 'MMM-StyledSlideshow',
         position: 'middle_center'
+        module: 'MMM-StyledSlideshow',
+        position: 'middle_center'
     },
 ```
 
 Configuration with all options:
 
 ```js
     {
+        module: 'MMM-StyledSlideshow',
+        position: 'middle_center',
         module: 'MMM-StyledSlideshow',
         position: 'middle_center',
         config: {
@@ -62,14 +71,18 @@ Option|Possible values|Default|Description
 ------|------|------|-----------
 `imageFolder`|`string`|`example_images`|The folder to draw images from. MUST be a subfolder of MMM-StyledSlideshow.
 `scrollInterval`|`integer`|`30000`|The rotation interval, in milliseconds
-`width`|`integer`|`20`|The width of the image, in % of screen width
-`height`|`integer`|`20`|The height of the image, in % of screen height
+`refreshInterval`|`integer`|`360000`|The interval on which the program reloads all pictures from the folder
+`width`|`integer`|`20`|The width of all pictures, in % of screen width
+`height`|`integer`|`20`|The height of all pictures, in % of screen height
+
+> As of now, the refreshInterval is a placeholder because of a bug I haven't figured out yet. If anyone wants to try, please fork the repo and once fixed, I will merge it. 
 
 ## Sending notifications to the module
 
 Notification|Description
 ------|-----------
 CHANGE_IMAGE|Change the current image
+CHANGE_IMAGE|Change the current image
 
 ## License
 

node_helper.js

@@ -25,10 +25,12 @@ module.exports = NodeHelper.create({
       this.currentIndex = (this.currentIndex + 1) % this.imagePaths.length;
     }
     else if (notification == "GET_PATHS"){
-      this.cycleFiles(payload);
+      this.getFiles(payload);
     }
   },
-  cycleFiles: function(folderPath){
+
+  getFiles: function(folderPath){
+    this.imagePaths = []
     const modulePath = path.join(__dirname, folderPath);
     fs.readdir(modulePath, (err, files) => {
       if (err) return console.error(err);