Compare commits

...

7 Commits

Author SHA1 Message Date
c1579f2edf add link to opensheet 2025-11-24 11:51:23 -05:00
5bdd48a0d2 Fix spelling error 2025-11-24 08:49:11 -05:00
51a9e801b2 Update images in readme 2025-11-22 10:39:50 -05:00
4a961c865e Re-orgnize repo files 2025-11-22 10:38:29 -05:00
9d0dac7e7b Add links and images to readme 2025-11-22 10:27:08 -05:00
569260634c Increment Version in Readme 2025-11-21 15:56:04 -05:00
7ae1318376 Add plugin icons for room and welcome center.
- Add room data plugin icon.

- Add welcome center plugin icon.
2025-11-21 15:53:45 -05:00
9 changed files with 65 additions and 3 deletions

40
AGENTS.md Normal file
View File

@@ -0,0 +1,40 @@
# TRMNL Plugin Development Guidelines
## Project Overview
This is a TRMNL platform plugin for displaying room data from Google Sheets on connected devices. The plugin uses Liquid templating for the frontend and YAML for configuration.
## File Structure
- `full.liquid` - Main Liquid template file for rendering room data
- `settings.yml` - Plugin configuration including API endpoints and custom fields
- `MeetingRooms-sample-data.json` - Sample data structure reference
## Code Style Guidelines
### Liquid Templating
- Use Liquid syntax for data binding and conditional logic
- Follow existing naming conventions: use snake_case for variables
- Keep HTML structure clean and semantic
- Use TRMNL-specific classes for styling (layout, columns, grid, etc.)
### YAML Configuration
- Use YAML format for all configuration files
- Follow existing key naming conventions (snake_case)
- Include proper descriptions for custom fields
- Use string quotes for all string values
### General Development
- No build/test commands - this is a static plugin
- Validate Liquid syntax by testing in TRMNL platform
- Ensure Google Sheets API URLs are correct and accessible
- Test with various device IDs using TRMNL_ID matching
### Testing
- Test by deploying to TRMNL platform with different device IDs
- Verify data loads from Google Sheets correctly
- Check responsive behavior on TRMNL devices
- Validate fallback logo displays when no data is available
## Key Components
- Device ID matching via `trmnl.plugin_settings.custom_fields_values.device_id`
- Data filtering using `where` filter in Liquid
- Google Sheets integration via opensheet.elk.sh API

View File

@@ -1,6 +1,6 @@
## CEDARMORE Room Data TRMNL Plug-in - ReadMe ## CEDARMORE Room Data TRMNL Plug-in - ReadMe
**Version:** 1.1 **Version:** 1.2
**Description:** **Description:**
@@ -12,3 +12,25 @@ The plug-in functions by linking to a Google Sheet. The sheet contains the room
**New Feature - Not In Use Mode:** **New Feature - Not In Use Mode:**
Each display can now be marked as "Not In Use" by setting the `not_in_use` field to "TRUE" in the spreadsheet. When enabled, the display will show the Cedarmore logo instead of room data, allowing for easy identification of unavailable displays. Setting `not_in_use` to "FALSE" will show the normal room information. Each display can now be marked as "Not In Use" by setting the `not_in_use` field to "TRUE" in the spreadsheet. When enabled, the display will show the Cedarmore logo instead of room data, allowing for easy identification of unavailable displays. Setting `not_in_use` to "FALSE" will show the normal room information.
## Images
![Layout 1](screenshots/20250617_142932.jpg)
![Layout 2](screenshots/20250617_130122.jpg)
![Logo Display](screenshots/20250617_124308.jpg)
![TRMNL_Plugin_Settings](screenshots/TRMNL_Plugin_Settings.png)
![Cedarmore_Room_Data_Google_Sheets](screenshots/Cedarmore_Room_Data_Google_Sheets.png)
## Links
- [Crossings Room Data Spreadsheet](https://docs.google.com/spreadsheets/d/1i9emEf-_b0pkZxP4G3_IivfqozJAb2k8TnK9HfRBDAQ/edit?gid=681330367#gid=681330367)
- [List Of Plugins](https://usetrmnl.com/plugin_settings?keyname=private_plugin)
- [Framework Design System](https://usetrmnl.com/framework)
- [Liquid 101 Template System](https://help.usetrmnl.com/en/articles/10671186-liquid-101)
- [Custom plugin filters](https://help.usetrmnl.com/en/articles/10347358-custom-plugin-filters)
- [Advanced Liquid](https://help.usetrmnl.com/en/articles/10693981-advanced-liquid)
- [TRMNL Shop](https://shop.usetrmnl.com/)
- [OpenSheet](https://github.com/benborgers/opensheet#readme) - Converts Google sheet to json data

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.4 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.5 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 154 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 312 KiB