Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Device

PLC that uses programmable logic.

Devices referenced in this document are PLC processors and HMI handheld pendant.

Program

AKA code, application, source code

The control logic, memory and parameters running in a Device.

Master

The running code in the Device that you make changes.

Software definition for published software is that the Master is the controlled source code from which all copies are made. It is the program we start with when making changes.

PLC prototype world (the one we live in) is different from other software environments.

We have, and will only ever have, one installation of each program. It is our running code. There is one instance. It exists on the Target Device.

Controlled Copy

For PLC programs:

The Controlled Program uploaded and saved in the appropriate git folder. It is our preferred Backup.

For HMI program:

The source code that was downloaded into the HMI and saved in the appropriate git folder. It is our preferred Backup.

Uncontrolled Copy

All other copies of the program. 

These are usually For Reference Only.

Working Copy

Any copy of the program that has been modified while not online with the Device.

Working copies should be uniquely named to avoid misidentification as a Controlled Copy or git-copy Uncontrolled Copy.

git folder 

The folder containing the Controlled Copy.

It is created on your computer during  installation of git.

Do not save working programs in git.

git_copy folder

The DropBox folder for uncontrolled copies that have been directly uploaded from the Device. 

This folder is available for use by anyone. It is not required to use this folder. It is a history of the running code on the date saved. This is useful when the Controlled Copy is not updated during the course of a code change. 

Do not modify programs in git_copy.

Do not save working programs in git-copy.

upload

Transfer a program from the http://Device.to the editor.

download

Transfer a program from the editor to the Device

Verify

Confirm that the code change is according to the specification.

Validate

Confirm that the code change operates according to the specification.

Safety Signature

...

You are welcome to participate. Otherwise inform the GateKeeper Gatekeeper when changes are made.

Whenever the Controlled Copy is updated:

...

Set the ‘Read Only’ file attribute on the Controlled Copy and the git-copy file

If the Controlled Copy becomes unavailable or

...

unusable

Locate the most recent or most applicable Uncontrolled Copy.

...

Set the ‘Read Only’ file attribute on the Controlled Copy.

If the Controlled Program becomes unavailable or

...

unusable

If possible, upload the program and save with a unique filename. This will help in diagnosing the problem.

...

Code Review Guidelines

Compare the code to the specificatonspecification

Identify Obvious Bugs. ...

...