Difference between revisions of "Template:VALT Keypad - Old"

From IVS Wiki
Jump to: navigation, search
(Through Putty)
m (IVSWikiBlue moved page VALT Keypad to Template:VALT Keypad - Old without leaving a redirect)
 
(17 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
===2x20===
 
===2x20===
 
Use '''male''' pin connectors.
 
Use '''male''' pin connectors.
: [[File:Keypad2x20CablePins.png|1000px|link=https://ipivs.com/wiki/images/4/4c/Keypad2x20CablePins.png|Click To Expand]]
+
: {{img | file = Keypad2x20CablePins.png | width=800px}}
  
 
===2x3===
 
===2x3===
 
Use '''male''' pin connectors.
 
Use '''male''' pin connectors.
  
: [[File:The2x3KeypadCable.png|500px|link=https://ipivs.com/wiki/images/b/b0/The2x3KeypadCable.png|Click To Expand]]
+
: {{img | file = The2x3KeypadCable.png | width=500px}}
  
 
===1x7===
 
===1x7===
 
Use '''female''' pin connectors.
 
Use '''female''' pin connectors.
: [[File:The1x7KeypadCable.png|500px|link=https://ipivs.com/wiki/images/6/66/The1x7KeypadCable.png|Click To Expand]]
+
: {{img | file = The1x7KeypadCable.png | width=500px}}
  
 
===How to Connect===
 
===How to Connect===
 
A GPIO cable will be connected to the processing unit. Connect the cable as shown below. Ensure that the black cable in the 2x20 pin connector aligns with the white cable on the GPIO cable.  
 
A GPIO cable will be connected to the processing unit. Connect the cable as shown below. Ensure that the black cable in the 2x20 pin connector aligns with the white cable on the GPIO cable.  
 
Attach the wiring to the physical keypad as shown
 
Attach the wiring to the physical keypad as shown
: [[File:2x20IntoGPIO.png|1200px|link=https://ipivs.com/wiki/images/6/63/2x20IntoGPIO.png|Click to Expand]]
+
: {{img | file = 2x20IntoGPIO.png | width=800px}}
 
Plugging the cables into the keypad:
 
Plugging the cables into the keypad:
: [[File:Connect VALTKeypad.png|500px|link=https://ipivs.com/wiki/images/9/93/Connect_VALTKeypad.png|Click to Expand]]
+
: {{img | file = Connect VALTKeypad.png | width=500px}}
 
If done correctly your keypad should look like this.
 
If done correctly your keypad should look like this.
: [[File:Keypad connected.jpg|400px|https://ipivs.com/wiki/images/3/3d/Keypad_connected.jpg|link=https://ipivs.com/wiki/images/3/3d/Keypad_connected.jpg]]
+
: {{img | file = Keypad connected.jpg | width=400px}}
  
====DHCP====
+
==IP Address==
 +
===DHCP===
 
The VALT Keypad will automatically pull an IP address from DHCP. The IP address can be obtained by reviewing DHCP leases on the associated DHCP server. The hostname of the device is Keypad.
 
The VALT Keypad will automatically pull an IP address from DHCP. The IP address can be obtained by reviewing DHCP leases on the associated DHCP server. The hostname of the device is Keypad.
 
+
===Static===
====Static====
 
 
If no DHCP server is available, the VALT Keypad will default to a static IP address of 192.168.0.92.
 
If no DHCP server is available, the VALT Keypad will default to a static IP address of 192.168.0.92.
====Manual====
+
===From the Keypad===
 +
On the keypad, type '''*9''' to get the IP address of that device.
 +
:{{img | file = Get IP.png | width=600px}}
 +
===Manual===
 
The IP address from the keypad may also be obtained directly by plugging in a keyboard and running the following command from the console:
 
The IP address from the keypad may also be obtained directly by plugging in a keyboard and running the following command from the console:
 
<pre>ifconfig | more</pre>
 
<pre>ifconfig | more</pre>
Line 36: Line 39:
 
The IP address will be listed under interface '''eth0'''.
 
The IP address will be listed under interface '''eth0'''.
  
===Manually Setting an IP Address===
+
==Configuring the Keypad==
In order to set the IP address manually, connect to the Keypad using the ivsadmin user. The ivsuser account cannot change any settings. If connecting from the console, type the following to change accounts. There will be prompt for the ivsadmin password. <pre>su ivsadmin</pre>
+
===Via the Web Interface===
# Type the following, and press Enter: <pre>sudo nano /etc/dhcpcd.conf</pre>
 
# Scroll down until to the section for interface '''eth0'''.
 
# Remove the '''#''' at the start of the lines for static IP, static routers, and static domain_name_servers.
 
# Update the IP configuration to reflect the correct settings for the environment.
 
#:[[File:SmartButton2.png|link=https://ipivs.com/wiki/images/b/b5/SmartButton2.png]]
 
# Comment out the remaining lines in the file by adding a '''#''' to the start of the line.
 
#:[[File:SmartButton3.png|link=https://ipivs.com/wiki/images/b/b6/SmartButton3.png]]
 
 
 
===Configuring the Keypad===
 
====Via the Web Interface====
 
 
#Make sure the key pad is plugged in and on.  
 
#Make sure the key pad is plugged in and on.  
 
#:''If it is on you will see the IVS logo displayed on the screen''
 
#:''If it is on you will see the IVS logo displayed on the screen''
 
#:''If you see the error screen, the keypad is not connected to the server. For right now, this is okay.''
 
#:''If you see the error screen, the keypad is not connected to the server. For right now, this is okay.''
[[File:Keypad IVS Sceen.png|250px|link=]]
+
#: {{img | file = Keypad IVS Sceen.png | width=250px}}
[[File:Error Screen.png|250px|link=]]
+
#: {{img | file = Error Screen.png | width=250px}}
#On the keypad, type '''*9''' to get the IP address of that device.
 
#:''The default IP address of the keypad is 192.168.0.92
 
[[File:Get IP.png|600px|link=]]
 
 
#Connect your computer to the same network as the keypad.
 
#Connect your computer to the same network as the keypad.
 
#Open up a web browser and type in the IP address of the keypad.  
 
#Open up a web browser and type in the IP address of the keypad.  
Line 70: Line 60:
 
| admin51
 
| admin51
 
|}
 
|}
[[File:Keypad Webpage.png|1300px|link=https://ipivs.com/wiki/images/5/5b/Keypad_Webpage.png]]
+
{{img | file = keypad1.png | width=900px}}
 
#Log into your VALT server and go to the Observe tab.
 
#Log into your VALT server and go to the Observe tab.
 
#:Use the IP or domain of your VALT server.
 
#:Use the IP or domain of your VALT server.
 
#:Open the room you want to connect to the keypad.
 
#:Open the room you want to connect to the keypad.
 
#:Look at the URL bar to find the room number. You will use this to connect the keypad to that room.
 
#:Look at the URL bar to find the room number. You will use this to connect the keypad to that room.
[[File:VALT Screen Locations.png|1300px|link=https://ipivs.com/wiki/images/8/80/VALT_Screen_Locations.png]]
+
{{img | file = VALT Screen Locations.png | width=900px}}
 
#Go through the fields and fill out the information specific to your installation.  
 
#Go through the fields and fill out the information specific to your installation.  
[[File:Webpage Info.png|1300px|link=https://ipivs.com/wiki/images/f/f2/Webpage_Info.png]]
+
{{img | file = keypad3.png | width=900px}}
 
+
====Valt Configuration====
====Via Putty====
 
# Type the following, and press Enter: <pre>sudo nano /home/ivsuser/.bashrc</pre>
 
# Scroll down to the bottom of the file.
 
#:[[File:Keypad_script.png|800px]]
 
# Modify the last command in the file to match your environment. Make sure to remove the '''#''' from the beginning of the line. The settings are listed below.
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
| -s
+
|VALT Server Address
|Server IP Address or DNS entry
+
|This field should be populated with the server address for the VALT server. If the server is using https, you must include https:// in the server address.
 
|-
 
|-
| -u
 
 
|VALT Username
 
|VALT Username
 +
|This field the user name the keypad will use to authenticate to VALT. It must be a local account on the VALT server and the user must have permissions to access the room and start recordings as other users. It is recommended you create a service account with admin permissions.
 
|-
 
|-
| -p
 
 
|VALT Password
 
|VALT Password
 +
|This field is the password for the specified user.
 +
|-
 +
|VALT Room
 +
|This field is the room number the keypad will be linked to. After establishing a connection to the VALT server this field will be populated with the actual room names.
 +
|-
 +
|Status
 +
|This field shows the current status of the keypad's connection to the VALT server.
 +
|-
 +
|Retry Connection
 +
|Attempts to reconnect to the VALT server. This will not save any configuration changes made.
 +
|-
 +
|Recording Name
 +
|This field specifies the default name for recordings started with the keypad. The recording name may be changed later from the VALT web interface.
 +
|-
 +
|Marker Name
 +
|This field specifies the default name for markers created with the keypad.
 +
|}
 +
====PIN Configuration====
 +
This field specified the number of characters in the PIN code. All user PINs must be the same length.
 +
====Current Network Configuration====
 +
This section displays the current network configuration for the keypad.
 +
====Network Boot Configuration====
 +
This section allows for configuration of the wired and wireless network interfaces on the keypad.
 +
====Admin Configuration====
 +
{| class="wikitable"
 +
|-
 +
|Keypad Passcode
 +
|This field specified the pin code that must be entered on the keypad to access the keypad menu. This menu can be used to set the IP address of the keypad.
 +
|-
 +
|Web Password
 +
|This field specified the password used to log into the keypad web interface.
 +
|-
 +
|Change Password
 +
|Clicking this button will update the password used to log into the web interface.
 +
|-
 +
|Restart Service
 +
|Clicking this button will restart the keypad service.
 +
|-
 +
|Restart Keypad
 +
|Clicking this button will reboot the keypad.
 
|-
 
|-
| -r
+
|Web Interface
|VALT Room Number
+
|Clicking this button will disable the keypad web interface.
 
|-
 
|-
| --ssl
+
|Update Config Files
| '''True''' if the VALT server is using https, otherwise omit this option.
+
|Clicking this button will save all changes.
 
|}
 
|}
 
+
==Star Commands==
Reboot the keypad using the following command: <pre>sudo reboot</pre>
 
 
 
The keypad should begin functioning normally.
 
 
 
===Star Commands===
 
 
Typing any of the commands in the table below into the keypad will result in triggering a special function.
 
Typing any of the commands in the table below into the keypad will result in triggering a special function.
 
{| class="wikitable"
 
{| class="wikitable"
Line 123: Line 142:
 
|-
 
|-
 
|*5
 
|*5
|Not Used Currently
+
|Lock/Unlock Room
 
|-
 
|-
 
|*6
 
|*6
Line 140: Line 159:
 
|Reset LED Display
 
|Reset LED Display
 
|}
 
|}
 +
==Start a Recording==
 +
Recordings are started by typing in a users pin code. This will also assign the video to that user.
 +
*To add a pin code to a user, first go the user in the Admin section and select the user you want to assign a number to.
 +
{{img | file = Go to User(low res).gif | width=900px}}
 +
*Click on "Advanced Options" to open to the Card Number field.
 +
{{img | file = Go to Card Number(low res).gif | width=900px}}
 +
*Assign the user a pin.
 +
*Save the page.
 +
*Now the user can type that pin into a keypad to start a recording.
 +
 +
==Factory Default==
 +
On the keypad type *62476. The keypad will restore all settings to default and reboot.
  
===Disable the Fan===
+
{{img | file = Keypad IVS Sceen.png | width=250px}}
# Connect to the keypad via SSH.
 
# Type the following, and press Enter: <pre>sudo nano /boot/config.txt</pre>
 
# Scroll down to the bottom of the file and add the following line: <pre>disable_poe_fan=1</pre>
 
# Save the file.
 
# Reboot the keypad.
 

Latest revision as of 15:39, 29 March 2024

Configuration

Creating the Cable

  1. Cut two 15 foot lengths of 22/8 cable
  2. Use a 2x20 pin connector, a 2x3 pin connector, and a 1x7 pin connector, crimp and connect as shown below

2x20

Use male pin connectors.

Keypad2x20CablePins.png

2x3

Use male pin connectors.

The2x3KeypadCable.png

1x7

Use female pin connectors.

The1x7KeypadCable.png

How to Connect

A GPIO cable will be connected to the processing unit. Connect the cable as shown below. Ensure that the black cable in the 2x20 pin connector aligns with the white cable on the GPIO cable. Attach the wiring to the physical keypad as shown

2x20IntoGPIO.png

Plugging the cables into the keypad:

Connect VALTKeypad.png

If done correctly your keypad should look like this.

Keypad connected.jpg

IP Address

DHCP

The VALT Keypad will automatically pull an IP address from DHCP. The IP address can be obtained by reviewing DHCP leases on the associated DHCP server. The hostname of the device is Keypad.

Static

If no DHCP server is available, the VALT Keypad will default to a static IP address of 192.168.0.92.

From the Keypad

On the keypad, type *9 to get the IP address of that device.

Get IP.png

Manual

The IP address from the keypad may also be obtained directly by plugging in a keyboard and running the following command from the console:

ifconfig | more

The IP address will be listed under interface eth0.

Configuring the Keypad

Via the Web Interface

  1. Make sure the key pad is plugged in and on.
    If it is on you will see the IVS logo displayed on the screen
    If you see the error screen, the keypad is not connected to the server. For right now, this is okay.
    Keypad IVS Sceen.png
    Error Screen.png
  2. Connect your computer to the same network as the keypad.
  3. Open up a web browser and type in the IP address of the keypad.
    Make sure to add "https://" to the beginning of the IP.
  4. Log into the keypad using its credentials.
Default Credentials
Username ivs
Password admin51

Keypad1.png

  1. Log into your VALT server and go to the Observe tab.
    Use the IP or domain of your VALT server.
    Open the room you want to connect to the keypad.
    Look at the URL bar to find the room number. You will use this to connect the keypad to that room.

VALT Screen Locations.png

  1. Go through the fields and fill out the information specific to your installation.

Keypad3.png

Valt Configuration

VALT Server Address This field should be populated with the server address for the VALT server. If the server is using https, you must include https:// in the server address.
VALT Username This field the user name the keypad will use to authenticate to VALT. It must be a local account on the VALT server and the user must have permissions to access the room and start recordings as other users. It is recommended you create a service account with admin permissions.
VALT Password This field is the password for the specified user.
VALT Room This field is the room number the keypad will be linked to. After establishing a connection to the VALT server this field will be populated with the actual room names.
Status This field shows the current status of the keypad's connection to the VALT server.
Retry Connection Attempts to reconnect to the VALT server. This will not save any configuration changes made.
Recording Name This field specifies the default name for recordings started with the keypad. The recording name may be changed later from the VALT web interface.
Marker Name This field specifies the default name for markers created with the keypad.

PIN Configuration

This field specified the number of characters in the PIN code. All user PINs must be the same length.

Current Network Configuration

This section displays the current network configuration for the keypad.

Network Boot Configuration

This section allows for configuration of the wired and wireless network interfaces on the keypad.

Admin Configuration

Keypad Passcode This field specified the pin code that must be entered on the keypad to access the keypad menu. This menu can be used to set the IP address of the keypad.
Web Password This field specified the password used to log into the keypad web interface.
Change Password Clicking this button will update the password used to log into the web interface.
Restart Service Clicking this button will restart the keypad service.
Restart Keypad Clicking this button will reboot the keypad.
Web Interface Clicking this button will disable the keypad web interface.
Update Config Files Clicking this button will save all changes.

Star Commands

Typing any of the commands in the table below into the keypad will result in triggering a special function.

*1 Share Current Recording With A User
*2 Share Current Recording With A Group
*3 Pause Current Recording
*4 Add a Marker
*5 Lock/Unlock Room
*6 Not Used Currently
*7 Menu
*8 Reboot Keypad
*9 Display IP Address
*0 Reset LED Display

Start a Recording

Recordings are started by typing in a users pin code. This will also assign the video to that user.

*To add a pin code to a user, first go the user in the Admin section and select the user you want to assign a number to.

Go to User(low res).gif

*Click on "Advanced Options" to open to the Card Number field.

Go to Card Number(low res).gif

  • Assign the user a pin.
  • Save the page.
  • Now the user can type that pin into a keypad to start a recording.

Factory Default

On the keypad type *62476. The keypad will restore all settings to default and reboot.

Keypad IVS Sceen.png