Skip to content

Commit

Permalink
FAQ Update
Browse files Browse the repository at this point in the history
  • Loading branch information
gcobb321 committed Apr 2, 2024
1 parent aea44a8 commit 6f00285
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 9 deletions.
7 changes: 4 additions & 3 deletions docs/chapters/1.2-event-log.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ The following yaml will create the Event Log custom card on the dashboard card y
square: false
columns: 1
cards:
- type: custom:icloud3-event-log-card
- type: 'custom:icloud3-event-log-card'
```
Expand Down Expand Up @@ -161,7 +161,7 @@ The following yaml will create the Event Log custom card on the dashboard card y
square: false
type: grid
cards:
- type: custom:icloud3-event-log-card
- type: 'custom:icloud3-event-log-card'
```
Expand Down Expand Up @@ -189,7 +189,8 @@ Do the following to set it up manually:
3. Enter the following:
- `/local/icloud3/icloud3-event-log-card.js` in the **URL** field
- `/local/icloud3/icloud3-event-log-card.js` in the **URL** field.
- DO NOT ENTER `/www/icloud3/icloud3-event-log-card.js` . It will not work.
- Check **JavaScript Module**
4. Select **Create (or Update)**
Expand Down
9 changes: 6 additions & 3 deletions docs/chapters/8.2-configuration-setup-issues-md.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,14 @@ This means that Location Sharing is probably not enabled on the iDevice. On the
- **Check the Directory containing the Event Log Card program** - When iCloud3 is installed, the Event Log's *icloud3-event-log-card.js* file is copied to it's *www/* directory. Verify that the file was copied to that directory.
- New installations - It is copied into the *www/icloud3* directory.
- v2 Migrations - The *www/* you were using in iCloud3 v2 is used in v3. The default directory for v2 is *www/custom_cards*. However, you may have changed it to another directory and specified that in the `event_log_card_directory` parameter.

- **Check the Directory name in the iCloud3 Configuration** - Verify the directory name containing the Event Log's *icloud3-event-log-card.js* file is correct on the *Configure Settings > Tracking and Other Parameters* screen. It is listed at the bottom of the parameter list. If not, select the correct directory in the list.
- **Check the Lovelace Resource parameter** - This is a Lovelace parameter specified on the *Settings > Dashboard > : > Resources* screen. This screen specifies *local/directory/file-name.js* for various Lovelace card '.js' files used HA. iCloud3 tries to add or update this list when it starts with the Event Log card's directory above.
- Find and verify that the iCloud3 entry, */local/icloud3/icloud3-event-log-card.js* is in the list. Add it if is not. More information about this is in the *iCloud3 Components, Event Log* documentation [here](chapters/1.2-event-log?id=lovelace-resource-for-the-event-log).

- **Check the Lovelace Resource parameter** - This is a Lovelace parameter specified on the *Settings > Dashboard > ⋮ > Resources* screen. This screen specifies *local/directory/file-name.js* for various Lovelace card '.js' files used HA. iCloud3 tries to add or update this list when it starts with the Event Log card's directory above.
- Find and verify that the iCloud3 entry, */local/icloud3/icloud3-event-log-card.js* is in the list. Add it if is not. More information about this is in the *iCloud3 Components, Event Log* documentation [here](#/chapters/1.2-event-log?id=lovelace-resource-for-the-event-log).
- The value you enter for the resource starts with */local*. It does not start with */www*.
- **Check the value you are entering when setting up the Dashboard** - You specify the *icloud3-event-log-card* as a custom card when you add it to a Dashboard screen is `type: 'custom:icloud3-event-log-card'`. More information about this is in the *iCloud3 Components, Event Log* documentation [here](chapters/1.2-event-log?id=create-a-new-dashboard-card-for-the-event-log).

- **Check the value you are entering when setting up the Dashboard** - You specify the *icloud3-event-log-card* as a custom card when you add it to a Dashboard screen is `type: 'custom:icloud3-event-log-card'`. More information about this is in the *iCloud3 Components, Event Log* documentation [here](#/chapters/1.2-event-log?id=create-a-new-dashboard-card-for-the-event-log).
- It must not have any spaces at the end.
- Do not add `.js` at the end.
- These are wrong: `type: 'custom:icloud3-event-log-card '` and `type: 'custom:icloud3-event-log-card.js'`
Expand Down
6 changes: 3 additions & 3 deletions docs/chapters/8.2-configuration-setup-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@
</ul>
</li>
<li><strong>Check the Directory name in the iCloud3 Configuration</strong> - Verify the directory name containing the Event Log&#39;s <em>icloud3-event-log-card.js</em> file is correct on the <em>Configure Settings &gt; Tracking and Other Parameters</em> screen. It is listed at the bottom of the parameter list. If not, select the correct directory in the list.</li>
<li><strong>Check the Lovelace Resource parameter</strong> - This is a Lovelace parameter specified on the <em>Settings &gt; Dashboard &gt; : &gt; Resources</em> screen. This screen specifies <em>local/directory/file-name.js</em> for various Lovelace card &#39;.js&#39; files used HA. iCloud3 tries to add or update this list when it starts with the Event Log card&#39;s directory above.<ul>
<li>Find and verify that the iCloud3 entry, <em>/local/icloud3/icloud3-event-log-card.js</em> is in the list. Add it if is not. More information about this is in the <em>iCloud3 Components, Event Log</em> documentation <a href="chapters/1.2-event-log?id=lovelace-resource-for-the-event-log">here</a>. </li>
<li><strong>Check the Lovelace Resource parameter</strong> - This is a Lovelace parameter specified on the <em>Settings &gt; Dashboard &gt; : &gt; Resources</em> screen. This screen specifies <em>local/directory/file-name.js</em> for various Lovelace card &#39;.js&#39; files used HA. iCloud3 tries to add or update this list when it starts with the Event Log card&#39;s directory above.<ul>
<li>Find and verify that the iCloud3 entry, <em>/local/icloud3/icloud3-event-log-card.js</em> is in the list. Add it if is not. More information about this is in the <em>iCloud3 Components, Event Log</em> documentation <a href="#/chapters/1.2-event-log?id=lovelace-resource-for-the-event-log">here</a>. </li>
<li>The value you enter for the resource starts with <em>/local</em>. It does not start with <em>/www</em>.</li>
</ul>
</li>
<li><strong>Check the value you are entering when setting up the Dashboard</strong> - You specify the <em>icloud3-event-log-card</em> as a custom card when you add it to a Dashboard screen is <code>type: &#39;custom:icloud3-event-log-card&#39;</code>. More information about this is in the <em>iCloud3 Components, Event Log</em> documentation <a href="chapters/1.2-event-log?id=create-a-new-dashboard-card-for-the-event-log">here</a>. <ul>
<li><strong>Check the value you are entering when setting up the Dashboard</strong> - You specify the <em>icloud3-event-log-card</em> as a custom card when you add it to a Dashboard screen is <code>type: &#39;custom:icloud3-event-log-card&#39;</code>. More information about this is in the <em>iCloud3 Components, Event Log</em> documentation <a href="#/chapters/1.2-event-log?id=create-a-new-dashboard-card-for-the-event-log">here</a>. <ul>
<li>It must not have any spaces at the end. </li>
<li>Do not add <code>.js</code> at the end. </li>
<li>These are wrong: <code>type: &#39;custom:icloud3-event-log-card &#39;</code> and <code>type: &#39;custom:icloud3-event-log-card.js&#39;</code></li>
Expand Down

0 comments on commit 6f00285

Please sign in to comment.