Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Lint: dangling point definitions #2

Open
stevedh opened this issue Mar 29, 2023 · 0 comments
Open

Lint: dangling point definitions #2

stevedh opened this issue Mar 29, 2023 · 0 comments

Comments

@stevedh
Copy link
Contributor

stevedh commented Mar 29, 2023

When linting the OAP definitions, I found the following points which appear in equipment definitions but don't have a matching definition in a points file. I am happy to add the missing definitions but I'm not sure what all of them are, to be honest.

  • DVST: something to do with VFDs? I couldn't figure this one out.
  • ENERGY: appears on FCUVRFZC and UPS. Doesn't seem the same as ENERGYNET, --> make a new point definition ENERGY "energy, sensor,total"
  • EVPRRLT: --> use EVPRFLT?
  • HWBPVCMD: is this a "hot water boiler valve command"? It's on the HWPL (hot water plant).
  • ILLUM: seems pretty similar to LTPC although it's not really a photocel (this is on CAM) --> use LTPC.
  • OCCST: eg on ACU. --> use OCCEFFSP?
  • RAPWR: eg on PDU. --> use REACPWR?
  • VFB: on CHB. Seems like there are a few valve feedbacks (CWVFBK). What valves does a chilled beam have?
  • WDWSW: on CHB. Is this a window switch (WDST)?
  • LTLVLSP: is this needed or can all the instances be changed to EFLTLVLSP?
stevedh added a commit to normalframework/ontology that referenced this issue Apr 12, 2023
@stevedh
Lint: add basic ontology linting for structure and spelling
308a6f6 
This commit starts to add additional linting for the OAP, in order to
validate the structure and content of the documents.  There are two
pieces to this commit:

 * Structural linting uses yamale to validate the OAP data against
   yaml schema for equipment, points, and tags files.  The schemas are
   based on the actual data present and so might not be exactly what
   the designers intended; but prevent indentation errors.
 * Spellchecking runs cspell on the text.  Identifiers and other words must be
   added to lint/ids.txt or the build will fail.
 * Two github workflows which run these linters on commit.

In the future, we should add additional check; eg to ensure each point
has a definition (see OntologyAlignmentProject#2); but until that issue is closed the test
would fail anyways.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@stevedh