L3AV Control Programming Process v1.1.00
Revised 12-20-24
Purpose & Scope:
This card describes the complete process required for successful programming of custom control solutions for AV projects.
v1.1.00 removes ALL Netsuite tasks from the programming process
Process Flowchart
Process:
- Applicable steps are required for successful completion of every project.
- GUI (CLIENT APPROVAL IS REQUIRED ON EVERY PROJECT)
- As described below GUI submittals are MANDATORY and must be completed prior to staging.
- Use the template form located at the end of this card
- For Micron projects the programmer must edit the Control Specification to match the design of the room(s) that are being programmed.
- There are premade files in 01 Micron Info/Control Sec and QRG folder
- LOGIC
- This step is required and to be completed when the GUI is done. Dates are scheduled by the Engineering Manager
- Smaller projects will require logic and GUI to be completed during staging, or the day prior to staging
- DSP (where applicable) (the DSP process is covered in another Guru card)
- To be completed prior staging
- Staging and Onsite efforts are scheduled during the weekly review with the FE/Install teams
- Programming calendar is updated during that meeting
- Programmer shall attend all project related meetings
- PM shall invite the programmer to the internal KO meeting
- This is the time where any issues or discrepancies are addressed.
- Record any meeting notes in the One Note file for programming in the client's Team
- Work is added to the Programming calendar by Engineering Manager based on weekly meetings with the L3 Micron/House teams and OPS
- All programmers have access to add/remove items from the programming calendar.
- This is designed to maintain visibility of items not directly related to programming jobs. Each programmer is encouraged to add any personal/professional obligations to the calendar for visibility
- In the event there is a conflict contact the Engineering Manager to resolve any schedule issues.
- Programmer creates folder in the _Projects or _Micron Projects Dropbox folder
- Sample folder structure is located at
- Level 3 Audio Visual Dropbox\PGM\_Projects\9999 - CLIENT - Job Name
- Use of this folder structure is mandatory
- Files are created with the following naming convention
- Example = 4349_Carollo_Portland_Room1_v1.0.07
- Format = [ProjectNumber this is mandatory]_[Client(this field is optional)]_[ProjectName(this field is optional)]_[SystemNameIfApplicable(this field is optional)]_v[Major].[Minor].[Bugfixes]
- Use of this naming convention is mandatory
- Once in Staging changelog is to be updated every time a new version is saved
- The programmer that initially writes the code keeps the folder in the main folder
- Sub folders are created for each space with the programmer's initials (see 5552 as example)
- Initial version (v1.0.00) does not require a Changelog entry
- All subsequent versions (after Staging begins) require a Changelog entry following the Changelog format
- Use of the Changelog is mandatory
- In the event that Dropbox is not available at the end of a particular day and alternative backup is required. This is typically in the form of an external drive.
- If an external drive is needed, inform the Engineering Manager and L3AV will provide one
- Do not power off your laptop without an external copy somewhere
- Daily backup of changed files is mandatory
- Make sure Dropbox is done syncing before powering down your laptop
- Programmer creates GUI submittal
- This is required for all projects (even if there is no GUI task)
- GUI SUBMITTAL MUST BE COMPLETED PRIOR TO STAGING
- Staging team needs this document to validate programming for AV9000 compliance
- This includes button panels and keypads
- Engineering Manager approval is required for not doing GUI submittals
- Verify type of GUI required via PM/Proposal
- L3AV standard
- Client Standard
- Micron Control Specification edit to match room capabilities
- Other (typically custom)
- Use approved GUI submittal form only (link included at the bottom of this document)
- Send GUI submittal to BE for review
- BE to acknowledge GUI covers all intended design requirements
- OR BE and programmer shall schedule a meeting to align GUI functions to design intent
- Copy GUI submittal to Cortex prior to staging
- Staging will use the GUI as a reference for labelling keypads and testing the system’s operation
- GUI to be completed during staging, if needed, to allow accurate screen shots from Zoom etc that use active equipment
- Micron requires a (PM coordinated) Control Spec page turn with UCC and the local Business Unit for EVERY project.
- Logic is developed for the project and completed prior to staging date
- Logic time is scheduled by Engineering Manager, but it is the programmer’s responsibility to ensure sufficient time is allocated and to notify Engineering Manager if additional time is needed or if too much time has been allocated
- Staging is scheduled by Engineering Manager in alignment with OPS
- Staging includes complete testing of all DSP and programmed functions
- The programmer is responsible for ensuring that all programming is tested by the staging team
- Perform daily updates to the project’s Teams channel
- This is mandatory for every day worked on a project in staging
- List items tested, not tested and reasons for not testing
- Enter any red flags that arise during the staging testing process
- Red flags, if critical should not wait for daily updates
- Onsite deployment is added to the programming calendar by the Engineering Manager in alignment with OPS
- Programmer shall be available during the onsite deployment process and assist as needed
- The programmer is responsible for ensuring that all programming is tested by the onsite team
- QRC shall be completed and delivered to the PM prior to training
- Copy QRC into the project folder
- Any final edits to the QRC shall be completed prior to the archiving of code
- All customers use the standard QRC (except Micron)
- Perform daily updates to the project’s Teams channel
- This is mandatory for every day worked and/or scheduled on a project onsite
- Enter any red flags that arise during the onsite testing process
- Once all functions have been verified by the onsite team and training has been completed the programmer shall copy completed programming in L3AV format to Cortex once the onsite deployment is completed
- DO THIS AS SOON AS YOU FEEL THAT THE PROGRAMMING IS DONE
- THIS APPLIES TO SERVICE PROJECTS AS WELL
- IN ADDITTION UPDATE THE SERVICE CASE NOTES INDICATING WHAT WAS DONE AND THE VERSION OF FILE COPIED TO THE PROJECT FOLDER
- You can always replace the files if changes need to be made later
- This includes completion of all punch list items that relate to programming
- Also included is the creation and delivery of the QRC (Quick Reference Chart) to the customer/PM
- Copy files to Cortex in the following format:
- The programming folder structure in its entirety gets copied over (first folder shown)
- Delete the DSP folder inside the programming folder (on Cortex only) to prevent confusion
- The CLIENT folder contains all REQUIRED files shown in the example below (programming files will vary by manufacturer)
- Description of files are as follows:
- GUI submittal (modified control spec for Micron) and QRC files
- Control system programming source code and COMPILED FILE
- Compiled files are required to support service needs
- Touch Panel file and COMPILED FILE
- Compiled panel files are required to support service needs
- JSON file used for Zoom portal (if applicable)
- Final DSP file
- Drawing files used during the development of the programming
- These may be different than the final files. These files represent a snapshot of how the system was installed and programmed
- All JSON config files used in the program
- The DSP folder contains the final DSP files (this may be updated by the FE after final commissioning)
- It is the programmer’s responsibility to ensure the latest DSP file is copied into the CLIENT folder
- If the DSP file is missing please inform the Engineering Manager
Related Resources:
9999_Client_Project_TP_User_Guide_v2.0.pub
https://app.getguru.com/card/TyAMpB8c/L3AV-DSP-Programming-Processv1100
Multiple Programmers working on a single Project (Control and/or DSP) v1.0.00