Skip to content

Commit

Permalink
Update ReadMe.md
Browse files Browse the repository at this point in the history
  • Loading branch information
krlaframboise authored Jan 3, 2017
1 parent 6c5954d commit f2b81cc
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions smartapps/krlaframboise/simple-event-logger.src/ReadMe.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<h1 id="simple-event-logger">Simple Event Logger - v1.0.2</h1>
<h1 id="simple-event-logger">Simple Event Logger - v1.1.0</h1>
<p>By Kevin LaFramboise (krlaframboise)</p>

<p><img align="right" src="https://raw.githubusercontent.com/krlaframboise/Resources/master/simple-event-logger/[email protected]" alt="Simple Event Logger Logo" />The Simple Event Logger is a fully customizable SmartApp that allows you to accurately log all device activity to a Google Sheets Spreadsheet. Each event is stored on a separate row so that you have their exact time and details.</p>
Expand Down Expand Up @@ -92,9 +92,9 @@
</ul><br></li>
<li>Select all the devices you want to log events for. You should see most of your devices in the "Actuators" and "Sensors" fields, but most of them will be in multiple fields. When you select a device, you're telling the SmartApp that it should log devices. Which events it should log is specified in a different section of the settings so it doesn't matter which field you select the device from.<br><br></li>
<li>After you've selected the devices you want to log events for, scroll down to the "Choose Events" section and select the events that should be logged for all devices.<br><br></li>
<li>If you want to log an event for some devices and not others you can use to corresponding "Device Exclusion" fields to exclude those devices.<br><br></li>
<li>If you want to log an event for some devices and not others you can use to corresponding "Device Exclusion" fields to exclude those devices. <em>(Due to timeout problems some users were experiencing, this feature has been moved into it's own section and won't be visible until you've completed the installation and re-opened the SmartApp)</em><br><br></li>
<li>Change the "Logging Options" (if needed)<br><ul><li><b>Log Events Every:</b> Determines the schedule interval for posting new events to the google sheet.</li>
<li><b>Maximum number of events to log for each device per section:</b> When the SmartApp Executes it retrieves between (1 and 50) events from the device since it last ran depending on this setting. Setting this number too high may cause the SmartApp to reach the 20 second execution limit and setting it too low may result in some events not getting logged.</li><li><b>Log Event Description:</b> Determines whether the event's description is logged. Google Sheets is limited to 2 million cells so it can hold about 400,000 events with the description or 500,000 events without it.</li></ul><br><br></li>
<li><b>Maximum number of events to log for each device per section:</b> When the SmartApp Executes it retrieves between (1 and 50) events from the device since it last ran depending on this setting. Setting this number too high may cause the SmartApp to reach the 20 second execution limit and setting it too low may result in some events not getting logged.</li><li><b>Log Event Description:</b> Determines whether the event's description is logged. Google Sheets is limited to 2 million cells so it can hold about 400,000 events, but only if columns F-Z have been deleted and no other sheets have been added.</li><li><b>Delete Extra Columns:</b>This automatically deletes columns F-Z if they're empty which allows you to log more events.</li></ul><br><br></li>
<li>Paste the Web App Url you previously copied from the <b>"Google Web App Url"</b> field.<br>
<ul><li>The url should start with "https://script.google.com/macros/s/"</li><li>If your url does not start like that, the SmartApp won't work so you need to go back into the Google Sheets Script Editor and copy the url from the publish screen.</li></ul><br><br></li>
<li>Once you've filled in all the required information and tapped done, it will initialize the logging schedule for the interval specified. After that scheduled amount of time, you should see new events logged to the spreadsheet and if you open the SmartApp, you will see information about the last time start it executed.<br><br></li>
Expand Down

0 comments on commit f2b81cc

Please sign in to comment.