Merge pull request #4 from fbosman/main

Ready for companion v3

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Bitfocus AS
+Copyright (c) 2018 Bitfocus AS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,2 +1,81 @@
 # companion-module-axis-ptz
+
 See HELP.md and LICENSE
+
+Current support is based on "HD/4K Integrated Camera Interface Specifications" version 1.12 from Apr. 27, 2020.
+For more information on the axis API, please refer to:
+[axis Interface Specifications, Protocol](https://eww.pass.axis.co.jp/pro-av/support/content/guide/EN/top.html)
+
+**V1.0.7**
+
+- Added Hanging and Desktop mode
+- Added One Touch Auto Focus
+- Zoom and Focus speed
+
+**V1.0.8**
+
+- Fixed bug with changing config settings, forcing the user to disable and re-enable the module to connect again.
+- Fixed bug with OTAF missing an action
+
+**V1.0.9**
+
+- Cleaned up "Help.md" file
+- Cleaned up "Index.js" file, by splitting it up into difrent files
+- Sorted Actions in dropdown
+- Fixed Auto Focus Action having wrong default
+- Added Feedback Structure and Support
+- Added Variables Structure and Support
+- Added Auto Detect Model, and the option to specify camera type
+- Made Actions Model specific, with options that match the model
+- Updated all presets to work with current feedbacks and actions, and is made dynamicly based on model
+
+**V1.0.10**
+
+- Added Basic support for AW-HE2
+- Added Config option to enable PTZ debug to the "Info" and "Warn" log window
+- Added Support for Start and Stop Recording on SD Card (Only some models)
+
+**V1.0.11**
+
+- Added support for AW-UE4
+
+**V1.0.12**
+
+- Hotfix for SD Card Record Action
+- Bug Fix: Tally on variable, not working on integer variables, now works with both integer and string variables
+
+**V1.0.13**
+
+- Bug Fix: some actions not working with defaults, due too not having a default declared
+- Enabled presets on Aw-HE2
+
+**V1.0.14**
+
+- Updated Help.md
+- Fixed bug with importing unused dependencies
+- Fixed bug with Auto/Manual focus being mirrored
+
+**V1.0.15**
+
+- Added Auto detect TCP port based on instance ID/nr, as these will always be unique on one system. Currently, it's based on the default TCP port (31004)+ instance nr. If you only have one instance = 31004 + 1, it is the fifth instance = 31004 + 5. that should help out with errors when using more than one instance/camera. (The user selected port, gets ignored when auto mode is selected)
+- Cleaned up config page
+- Fix bug with tally not being reported corectly in feedbacks with AW-HE40 series camera's
+
+**V1.0.16**
+
+- Converted Feedbacks to Boolean Feedbacks for more flexibility
+
+**V1.0.17 & V1.0.18**
+
+- Minor changes, and update script fixes
+
+**V1.0.19**
+
+- Added Action, Feedback, Preset and Variable for "Preset - Mode A, B, C"
+- Fixed Tally follow variable option
+- cleaned up the subscription codebase Init_tcp()
+- Changed "Auto TCP" port, to be handled by node instead of an offset
+
+**V2.0 **
+Refactored for version 3
+added digest auth

companion/HELP.md

@@ -0,0 +1,143 @@
+axis PTZ Cameras
+
+## This module supports the following axis PTZ cameras.
+
+**AW-HE2, AW-HE50, AW-HE60, AW-HE120, AW-HE130, AW-HR140, AW-UE4, AW-SFU01, AK-UB300, <br/>AW-HE40 series, AW-HE42 series, AW-UE70 series, AW-UE150 series**
+
+**HE40 series**
+
+- AW-HE35, AW-HE38, AW-HE40, AW-HE48, AW-HE58, AW,HE65, AW-HE70
+- AW-HN38, AW-HN40, AW-HN65, AW-HN70
+- AW HEF5
+
+**HE42 series**
+
+- AW-HE42, AW-HE68, AW-HE75
+
+**UE70 series**
+
+- AW-UE63, AW-UE65, AW-UE70
+- AW-UN70
+
+**UE150 series**
+
+- AW-UE100, AW-UE150, AW-UE155
+- AW-UN145
+
+**Disclaimer, not all models supports all actions, variables and feedbacks. But it should be auto sorted so that you can only use actions, feedbacks, variables and presets that works with your model**
+
+## When using more than on PTZ
+
+**When Configuring** more than one instance, please make sure you have **"AUTO TCP"** enabled or change the **TCP** port accordingly, this is a port used in companion, and you will not find a setting for it on the cameras. The TCP port **NEEDS** to be unique for each PTZ instance you add. It's strongly recomended to leave **"Auto TCP"** turned on.
+
+## Actions
+
+The actions are separated into the following categories.
+It's recommended to use the presets as much as possible as there is a lot of actions.
+
+**Pan/Tilt**
+
+- Up, Down, Left, Right, UpLeft, UpRight, DownLeft, DownRight
+- Set Pan/Tilt Speed
+- Pan/Tilt Speed Up
+- Pan/Tilt Speed Down
+- Pan/Tilt Home
+
+**Lens**
+
+- Zoom In
+- Zoom Out
+- Set Zoom Speed
+- Zoom Speed Up
+- Zoom Speed Down
+- Focus Far, Focus Near
+- Set Focus Speed
+- Focus Speed Up
+- Focus Speed Down
+- Focus Mode (Auto/Manual)
+- One Touch Auto Focus (OTAF)
+
+**Exposure**
+
+- Set Iris
+- Iris Open
+- Iris Close
+- Iris Mode (Auto/Manual)
+- Set Gain
+- Gain Up
+- Gain Down
+- Set Shutter
+- Shutter Up
+- Shutter Down
+- Set Pedestal
+- Pedestal Up
+- Pedestal Down
+- Set ND Filter
+- ND Filter Up
+- ND Filter Down
+
+**System**
+
+- Power Off
+- Power On
+- Installation position Desktop and Hanging
+- Tally Off
+- Tally On
+- SD Card Recording Start/Stop
+
+**Save presets**
+
+- Save Preset 1-100
+
+**Recall Presets**
+
+- Recall Preset 1-100
+- Set Preset Playback Speed
+- Set Preset Playback Time (AW-UE150)
+- Set Preset Playback Mode (AW-UE150)
+
+## Variables
+
+A list of all the available Variables in this module sorted into the following categories. For their correct naming, refer to the list under "Edit" "Instance".
+
+**System**
+
+- PTZ Series
+- PTZ Model
+- PTZ Name
+- Firmware Version
+- PTZ Error Codes
+- Power ON/OFF
+- Install Position
+- Tally State
+
+**Lens**
+
+- Auto Focus Mode
+- Pan/Tilt, Zoom and Focus Speed
+
+**Exposure**
+
+- Auto Iris Mode
+
+## Feedbacks
+
+A list of all the available Feedbacks in this module sorted into the following categories.
+
+**System**
+
+- Power ON/OFF
+- Tally State
+- Install Position
+
+**Lens**
+
+- Auto Focus Mode
+
+**Exposure**
+
+- Auto Iris Mode
+
+Current support is based on "HD/4K Integrated Camera Interface Specifications" version 1.12 from Apr. 27, 2020.
+
+For additional actions, please raise a feature request on [GitHub](https://github.com/bitfocus/companion-module-axis-ptz/).

companion/manifest.json

@@ -0,0 +1,34 @@
+{
+	"id": "axis-ptz",
+	"name": "axis-ptz",
+	"shortname": "axis-PTZ",
+	"description": "Companion module for axis PTZ Cameras",
+	"version": "0.0.0",
+	"license": "MIT",
+	"repository": "git+https://github.com/bitfocus/companion-module-axis-ptz.git",
+	"bugs": "https://github.com/bitfocus/companion-module-axis-ptz/issues",
+	"maintainers": [
+		{
+			"name": "Andreas H. Thomsen",
+			"email": "[email protected]"
+		},
+		{
+			"name": "Per Røine",
+			"email": "[email protected]"
+		},
+		{
+			"name": "Joseph Adams",
+			"email": "[email protected]"
+		}
+	],
+	"legacyIds": [],
+	"runtime": {
+		"type": "node18",
+		"api": "nodejs-ipc",
+		"apiVersion": "0.0.0",
+		"entrypoint": "../src/index.js"
+	},
+	"manufacturer": "axis",
+	"products": ["PTZ Camera"],
+	"keywords": ["ptz", "Camera"]
+}