oxrs-io / oxrs-io-website Goto Github PK

In the table for the buttonUpDown CMND,
The style description is incorrect.
Style shows as buttonLevelDown.
Should be buttonUpDown

https://oxrs.io/docs/firmware/touch-panel-esp32.html#json-parameters-10

I plan to help add this , but someone I'm sure can / may beat me to it.

add a section outline a recent superhouse discord conversation about firmware version numbers
talk about possible compatibility. and the numbers would be up to the firmware righter to ensure documentation is up to date, and make note of possible breaking points like mqtt , node red between versions

basic idea:
Given a version number MAJOR.MINOR.PATCH, increment the:

MAJOR version when you make incompatible API changes,
MINOR version when you add functionality in a backwards compatible manner, and
PATCH version when you make backwards compatible bug fixes.

breaking-change, new-feature, bug-fix

Links on page https://oxrs.io/guides/writing-docs/templates/ to https://oxrs.io/guides/templates/hardware-template.html and https://oxrs.io/guides/templates/firmware-template.html are 404'ing.

might also be worth adding a page talking about controllers - but more specifically the usage of the screen and possible layouts

this would be in regards to the work moin has done both overall and with their recent suggestions from sumnerboy on discord.

any possible layout or data in regards to other configurations between input and output options that someone my build could / may be discussed.

The first board I have (Austin's Creations) is the PWM Controller. capable of controlling many sets of "Dumb" LED strips via i2c

Has both hardware and basic software available to make it work
viewable here: https://github.com/austinscreations/PWM-LED-Controller

Will learn how to clone and do a pull request with added information for ease of implementation.

recommendation to add a webpage about Ethernet cable colors and possible recommendation for what people may use for what.

Blue for LAN.
Yellow for cctv
Green for poe devices.
Purple for access points
White for non data devices. Eg oxrs light switches
Orange
Red
black
grey

There are standards for patch cords.
Gray: Standard ethernet connection
Green: Crossover ethernet connection
Yellow: POE (power over ethernet)
Orange: Analog Non-Ethernet
Purple: Digital Non-Ethernet
Blue: Terminal server connection
Red: IP cameras
Black: additional general ethernet color for departmental use
Pink: additional general ethernet color for departmental use
White: additional general ethernet color for departmental use

add side bar link and a skeleton for the new upcoming FW OXRS-SHA-StateIO-ESP32-FW under https://oxrs.io/docs/firmware/

This has already come up in discord.

to avoid repeating oneself may be worth while to add a page about rack layout (and note that not all devices need to be in a rack case)

but for rack cases specifically talk about the layout options that were discussed long ago and why the selected layout was chosen.
layouts discussed can be found here: https://github.com/SuperHouse/URC/tree/main/URC-Rack-Layout

adding page with links to mechanical drawings for people designing rack faceplates.

granted makers could add them directly to their board documentation pages, but i think a one stop spot full of links my be helpful.

Was hoping to add maker designator for Austin's Creations (AC)
In relation to this page: https://oxrs.io/glossary/makers.html

I do have a terribly outdated website: austinscreations.ca

most of my work is posted on Instagram, and sometimes cross posted to twitter

Generate a Node-RED flow and TP32 Config file to use with the documentation around the TP32 Firmware.
The aim is to show the features of the firmware and how you may use them.
Planning to have one of each tile and some interactivity between them.

The pages under Guides look broken. No subsection headers are shown as links in the left hand navigation bar

Request for new maker code for Frank McAlinden.

No website.

• todo for me

We need to run the validation script against all .md files to validate their paths as well.

This is to make sure all links throughout the site are standardized so odd issues don't occur again.

Nav and sidebar are already validated, however main readme files are not.

I think we need something like an Overview chapter under Docs were documentation can go that refers not to a single component but addresses the OXRS eco system.
Here is an example that could reside here showing the SW layer structure.

npm run dev fails with the following error

/home/code/OXRS-IO-WEBSITE/node_modules/@vuepress/bundler-vite/lib/resolveViteConfig.js:15
}, options.viteOptions ?? {});
^

SyntaxError: Unexpected token '?'

2022-08-15T07_13_22_968Z-debug.log

This is on a fresh Debian 11 install with Visual Studio Code-Server, Git, Node and npm.

The "Input Config" requires update to reflect the changes in the JSON Schema

{"inputs":[{"index": 4, "type": "contact"}]}

{"inputs":[{"index": 7, "type": "button", "invert": true}]}

Making note that:
NPM failure to rebuild oxrs.io in PR #51

https://github.com/OXRS-IO/OXRS-IO-WEBSITE/runs/7057593918?check_suite_focus=true