forked from GeoNet/delta
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add helper sheets * updated order of steps * moved sheets into docs dir
- Loading branch information
Showing
4 changed files
with
722 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # COMMON ASSET MANAGEMENT TASKS | ||
|
|
||
| Although not strictly needed, the __asset__ files are used as a cross-check for when equipment | ||
| is installed. This is to try and catch errors related to serial numbers, and also to allow | ||
| using the asset numbers to further identify installed equipment. | ||
|
|
||
| The files in the __assets__ directory all have the same format. Each file represents an equipment | ||
| type which also constrains where the equipment can be installed. | ||
| For instance, only equipment in the __assets/sensors.csv__ file can be installed in the __install/sensors.csv__ file. | ||
|
|
||
| Generally __assets__ should be entered in before they are added to files in the __installs__ directory. | ||
|
|
||
| The presence of an asset "number" is an indication that the equipment is managed directly by __GeoNet__. | ||
|
|
||
| [_The files were not built for asset tracking or inventory management, however this may change with further requirements_] | ||
|
|
||
| ## Files | ||
|
|
||
| --- | ||
| * :page_with_curl: __assets/antennas.csv__ | ||
| * :page_with_curl: __assets/metsensors.csv__ | ||
| * :page_with_curl: __assets/radomes.csv__ | ||
| * :page_with_curl: __assets/receivers.csv__ | ||
| --- | ||
| * :page_with_curl: __assets/sensors.csv__ | ||
| * :page_with_curl: __assets/recorders.csv__ | ||
| * :page_with_curl: __assets/dataloggers.csv__ | ||
| --- | ||
| * :page_with_curl: __assets/cameras.csv__ | ||
| --- | ||
|
|
||
| ## :one: _Updating an existing asset entry_ | ||
|
|
||
| Find the appropriate __asset__ file for the type of equipment. | ||
|
|
||
| > ### :information_source: General requirements | ||
| > | ||
| > * If changed, the make, model, or serial number of the assets to update. | ||
| > * If changed, the equipment asset "numbers". | ||
| > * If changed, any equipment notes for the updated assets. | ||
| > ### :small_orange_diamond: Delta checks | ||
| > | ||
| > * There can only be one asset with the same make, model, and serial number. | ||
| > * There can only be one asset with the same asset "number". | ||
| > * Any references to these assets in the __install__ directory files will also need to be consistent. | ||
| ## :two: _Adding a new asset entry_ | ||
|
|
||
| Find the appropriate __asset__ file for the type of equipment. | ||
|
|
||
| > ### :information_source: General requirements | ||
| > | ||
| > * The make, model, and serial number of the new `assets. | ||
| > * Any optional asset "numbers" that may be available. | ||
| > * Any extra equipment notes that may be appropriate. | ||
| > | ||
| > ### :small_orange_diamond: Delta checks | ||
| > | ||
| > * There can only be one asset with the same make, model, and serial number. | ||
| > * There can only be one asset with the same asset "number". | ||
| ## _Overall steps_ | ||
|
|
||
| > * :file_folder: Using a suitable mechanism create a new _git_ branch for the changes. | ||
| > * :one: :pencil2: Update the __assets/<type>.csv__ files appropriate to the equipment model types. | ||
| > * :one: :pencil2: Update the __install/<type>.csv__ files where the equipment may be referenced. | ||
| > * :two: :pencil2: Add the new equipment into the __assets/<type>.csv__ files appropriate to the model types. | ||
| > * :open_file_folder: Build the pull request with a meaningful title. | ||
| > * :link: Assign suitable tags and set reviewers. | ||
| > * :repeat: If the tests fail, the above changes may need some iteration until they pass. | ||
| > * :sos: If the tests are still failing, escalate as this may indicate some inconsistency within the network configuration. | ||
| > * :ok: Once the tests have passed and the pull request reviewed, depending on policy, the pull request can be merged |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| # COMMON CAMERA TASKS | ||
|
|
||
| * :scroll: :one: [Creating or updating a camera __mount__](#mount) :dragon: | ||
| * :scroll: :two: [Installing or updating a __camera__](#camera) | ||
| * :hammer: [Combined editing steps](#steps) | ||
|
|
||
| The mounting of cameras used for monitoring operations are described in the __network/mounts.csv__ file. | ||
| Attached to each __mount__ are a camera "code", the physical location, a "name" (or caption), and a description of the overall "view". | ||
|
|
||
| Physical camera installs are managed through the __install/cameras.csv__ file. This includes | ||
| camera hardware details and the installation times. | ||
|
|
||
| ## :one: <a name="mark"></a>_Creating or updating an existing camera mount_ | ||
|
|
||
| > ### :page_with_curl: Files to update | ||
| > | ||
| > * __network/mounts.csv__ | ||
| > | ||
| > ### :page_with_curl: Reference files | ||
| > | ||
| > * __network/networks.csv__ [_currently not populated_] | ||
| > | ||
| New camera __mounts__ will need to have a "code" assigned by the appropriate mechanism. | ||
|
|
||
| It is intended that camera mounts are fixed in place, any adjustments will be applied retrospectively. | ||
| Changes over time of a camera's location, or view point, should be handled by building new camera __mounts__. | ||
|
|
||
| :dragon: **The image "name", and general "view" description are prominently used on the GeoNet web pages.** | ||
|
|
||
| > ### :information_source: General requirements | ||
| > | ||
| > * The camera __mount__ "code". | ||
| > * The expected image "name" or caption. | ||
| > * The overall "view" description. | ||
| > | ||
| > ### :information_source: Field requirements | ||
| > | ||
| > * The camera mount location. | ||
| > | ||
| > ### :heavy_check_mark: Delta prerequisites | ||
| > | ||
| > * There can only be one camera __mount__ for any given code. | ||
| ## :two: <a name="camera"></a>_Installing or replacing cameras_ | ||
|
|
||
| > ### :page_with_curl: Files to update | ||
| > | ||
| > * __install/cameras.csv__ | ||
| > | ||
| > ### :page_with_curl: Reference files | ||
| > | ||
| > * __assets/cameras.csv__ | ||
| > * __network/mounts.csv__ | ||
| > | ||
| > ### :information_source: General requirements | ||
| > | ||
| > * Camera __mount__ "code" (_where the camera is mounted_). | ||
| > * Any publicly readable notes relating to the installation. | ||
| > | ||
| > ### :information_source: Field requirements | ||
| > | ||
| > * Camera "make", "model", and "serial" numbers (_what is being installed or removed_) | ||
| > * Physical installation details, such as dip, azimuth (_direction the camera is pointing_), and height. | ||
| > * Camera installation times (_when the camera is installed, or removed_) | ||
| > | ||
| > If replacing an existing camera the installation details are likely to be the same, | ||
| > although a cross-check may be worthwhile. | ||
| > | ||
| > Use an end date of `9999-01-01T00:00:00Z` to indicate that a camera is currently installed. | ||
| > | ||
| > ### :heavy_check_mark: Delta prerequisites | ||
| > | ||
| > * The cameras need to be listed in the __assets/cameras.csv__ file. | ||
| > * The camera mounts need to be present in the __network/mounts.csv__ file. | ||
| > | ||
| > ### :small_orange_diamond: Delta checks | ||
| > | ||
| > * A given camera can only be mounted to a single __mount__ at any given time. | ||
| > * A camera __mount__ can only have one camera mounted at any given time. | ||
| ## <a name="steps"></a>_Overall steps_ | ||
|
|
||
| > * :file_folder: Using a suitable mechanism create a new _git_ branch for the changes. | ||
| > * :one: :pencil2: Update the __network/mounts.csv__ file to add or update any camera mount information, the entries will need to be in order of mount code. | ||
| > * :two: :pencil2: Update in the __install/cameras.csv__ file any equipment that has been removed or altered. | ||
| > * :open_file_folder: Build the pull request with a meaningful title. | ||
| > * :link: Assign suitable tags and set reviewers. | ||
| > * :repeat: If the tests fail, the above changes may need some iteration until they pass. | ||
| > * :sos: If the tests are still failing, escalate as this may indicate some inconsistency within the network configuration. | ||
| > * :ok: Once the tests have passed and the pull request reviewed, depending on policy, the pull request can be merged |
Oops, something went wrong.