labview-dcaf / documentation Goto Github PK

Write this.

Instead of just opening the example, they should start from an incomplete configuration (need to create this configuration)
and link some of the channels
Then add a logging module
Then add a CVT module and add some debugging

in step 4.c. of Excercise 3, the text references dropping the HandsOnCfgUI.VI method into the static reference. However, the screenshot has "Configuration UI.vi" being dragged into the static VI reference, which is quite confusing.

Create the new DCAF TRaining folder with the files to start working on it.

When refering to inputs to the system, the Hands-On references them as Outputs because it treats the direction as Module-centric. This is opposed to how we have ultimately defined the terminology. For example:

"
Take the following example to clarify the previous terminology. Let’s say a Module called Temperature Chamber Model has an Output Channel called Thermocouple Reading. This Thermocouple Reading Channel is mapped to a Tag called Temperature. Then the Temperature Tag is read by Temperature, an Input Channel that belongs to a module called Temperature Controller Logic. Study the following diagram to get a better understanding of these terms.
"

Should be changed to something like:
"
Take the following example to clarify the previous terminology. Let’s say a Module called Temperature Chamber Model has an Input Channel called Thermocouple Reading – the module implements reading from a thermocouple and puts the value into the Thermocouple Reading channel. This Thermocouple Reading Channel is mapped to a Tag called Temperature – the engine will then take the value that the module places onto the channel and put it on the tag. Then the Temperature Tag’s value is passed by the engine to Temperature, an Output Channel that belongs to a module called Temperature Controller Logic.
"

Documentation should be updated to change TBDF to DCAF along with a few small changes. I tracked a few suggested changes in the attached document.

DCAF Hands On.docx

I've learned people are perfectionists and will spend way too much time on this. For some this may be OK, but I'd encourage most people to steal the VI from the solution instead.

This could be Excersice 1 C, make this a separe excercise

We should explain the main goal of each exercise before people get started. Currently the instructions are fantastic, but people may not get a good understanding of why they are taking the steps that are asked of them.

Update the slides that have the graphviz diagrams with PowerPoint diagrams with the new format.

I noticed that some temporary lock files generated by Microsoft Office have been committed to the source.
For example, the following can be added to the .gitignore file:
~$.pptx
~$.docx

Document to describe any issue and install process from TBDF to DCAF

We need an example to explain the steps needed for creating a custom exe.

We may want to consider moving the guide to Markdown. It would be much easier to work on it and link to files or have rich media (Gifs to demonstrate concepts)

I know that someone had looked into it before but the main problem used to be on the relative difficulty of moving things to PDFs for the community.

After a brief discussion with @becega , it may make sense to change the community to links to the various chapters.

Write this.

We gave new or updated presentations at NI Week this year. We should update this repository with that content so we have the latest available.

After the last step of exercise 1 add a TDMS module to log to Disk. THis is to show how to Add New Modules and Configure

It seems that the TDMS file that gets created. However, when TCRL Host Main.vi stops, the TDMS file gets deleted. Not sure if this is a bug in the TDMS logger (I assume so) or a mis-configuration as explained in the Hands-On.

Write this.

Write this.

We are reordering the chapters, to make exercise flow better.

The new order is:

When going through the second excercise in the hands on step 5 has the user create a series of channels. After creating the channels the manual says that the channel configuration should look a specific way which includes the mapping.

Since the mapping is done later having the mapping be done is confusing. May want to remove the screenshot altogether, or take a screenshot from the project creation screen instead.

The editor needs a way add a line to the Channels tab. While it is possible that no changes onto the definition of a line are needed, if you must change a line (such that it creates two channels for example) this can be done through modifying the Line Configuration Dialog within the Editor Node.lvclass.

Missing paren where I bolded above.

It seems the File Name Prefix requirement in the Basic Execution Template was removed as mentioned here:
LabVIEW-DCAF/DCAF-Project-Templates#32
However the Hands On documentation instructs to add a prefix (TCRL) which cannot be done in the newest template. See Part 1 step 2 of Hands on.

Instead of opening th alredy createdhost main. use the project to create it.

Write this.

Fill this content.

There is a override that is note created every time that is the user initialization. We should tell users to use this rather than overriding the init vi.
We might want to create this instance in the templates

I'd like to see a checklist of sorts guiding users through what modifications are expected and necessary for creating a new module.

Example: a user needs to modify To Table to correctly display their data, validate.vi to add in any checks for bad configuration (and the detail that any error thrown by validate.vi will cause the red X over the module's glyph in the configuration tree), etc.

Still not certain why this is happening, but directly downloading the hands on material from github as a .zip file can change the end of line characters in the configuration files making them error when opened. We should post the hands on materials directly on the community to prevent other users from running into this.

Write this.

https://decibel.ni.com/content/projects/reference-designs-for-distributed-control-systems
I couldn't remember if there was already an issue for it, but don't forget all this content exists and should point to the new location.

I changed proj owner from myself to benjamin

The Hand-On is currently being distributed by having the users download the necessary folders. I would recommend that we, instead, move to a process where we build it into a VI Package.

This would allow for slightly easier distribution, but would ensure that the PCFG files do not break regardless of repo settings.

As part of reworking DCAF content should we create a main diagram of the possible DCAF learning paths?

This could be used as the first document someone who wants to learn about DCAF sees and we can use it to highlight specific content when there are things that overlap.

This is from Miles' feedback.

The Hands On could benefit from having some extra "background information" like what can be found in the introductory DCAF sessions.

For example, a page and a short description with a project screenshot detailing Editor vs Runtime information, which class does what, Tag VS Channel slide, etc, could be reasonably quick to set up but help people going through the Hands On both inside and outside of the class setting.

An additional comment specific to Excercise 3, it could be helpful to have a diagram/Hierarchy of the VIs to better drive home what they are supposed to be doing.

Update references to TBD to DCAFF
Update screenshots

I think we should work on changing the hierarchy such that content has a specific place it lives in.

We may want to consider moving presentations to a specific folder and having a standard name hierarchy for them. For example, separate NIWeek presentations from more generic ones, and have the generic presentations have a prefix detailing what they are for.

Additionally, do we want to have the NI Community master content be here in a series of files that we "push" to the NI Community?

We need to update the license text to the apache license. We also need to rename the file to LICENSE and add a NOTICE file. The Readme.md also needs to be updated to reference Apache. Finally the vipb file needs to be updated to include the Apache header to every source file.

The current version of the pcfg file in the hands-on is broken due to the class name changes implemented last week. Reminder to fix it with an updated version.

During the introduction,we should point people to the new community page, not the old one.

Add Slide after the excessive slide summarizing what they have to accomplish during the exercise.

Remove One of the tags for the user to create and map that tag.

Part 3 explains mappings with a table, but many people understand this better graphically. Even if users don't generate their own image, I think it might help to include a GraphViz diagram of this in the manual.