e4cash Configuration Reference PRELIMINARY

Transcription

1 e4cash Configuration Reference PRELIMINARY This document contains proprietary, privileged and preliminary information describing the e4cash multiple cash drawer network interface. This document and associated materials are Copyright 2012 Bernd Felsche, Innovative Reckoning, Perth, Western Australia. e4cash operating parameters are stored within the non-volatile part of memory and can be changed by connecting a computer to the USB port of the device. The computer should recognize it as a serial device. Open the serial connection with a terminal emulator such as PuTTY (download free from Set the Connection type to Serial, type in the name of the Serial line and set the speed to 9600 bps and the Terminal option Implicit CR in every LF selected. You may wish to save the settings as a named session in PuTTY. The e4cash device will reset when the connection opens. After the Copyright and version information banner, the device attempts to automatically configure the network settings using DHCP. Configuration will fail if no NTP server can be reached. Innovative Reckoning e4cash Configuration Reference Page 1

2 If the network setup fails because no NTP server can be reached, close the PuTTY session. Restart PuTTY but this time, when you connect to the device, press and hold the user button on the device after the first drawer's LED lights up (within a second). That bypasses setting up of the Ethernet connection on boot up. The Main Menu provides access to various management functions. Select an option by entering the corresponding letter and press Enter on your keyboard. Options Z, I and B should only be used after a firmware update. They destroy all previously stored settings. R resets all settings to factory default. Dynamic Variables shows several interesting values which are established once the network is up and running and drawers are operating. It will show e.g. the IP addresses of the device and all the servers and gateways. Dump EEPROM Map shows all settings at once in one long list. You can copy and save them into a text file as text for subsequent reference. The Pages Menu shows device settings grouped into pages of similar functions. Choose the P option to show the Pages Menu Individual pages of settings are chosen by entering the corresponding letter and pressing Enter Note: The cash drawer functions are disabled during the setting of values; between the entry of the S or R option and the confirmation of the change. Setting values can be changed by entering the corresponding 2-letter code in the page menu and then entering S to set a new value or R to reset the value to its factory default. Any changes require confirmation by entering Yes. A warning is issued if there have been any changes to settings. The device may not behave consistently until a reset. Closing PuTTY will reset the device. The stored settings will then be applied. Innovative Reckoning e4cash Configuration Reference Page 2

3 Configuration Pages S SysBase - System Basic Configuration Option Name Description Factory VR Version Memory Version (do not change) N/A RV Revision Memory Revision (do not change) N/A RL Release Memory Release (do not change) N/A BD Ser.Baud Serial port speed / 1200 (0 = 300 bps) 8 The memory version, revision and release numbers of settings is stored so that firmware upgrades do not use old settings which may be incompatible. Setting the serial speed to a value other than 8 (for 9600 bps) causes the device to enter a failsafe connection option on the next reset. e4cash detects the non-factory speed and provides the option to revert to factory setting, waiting for 2 seconds for a response. If there is no keyboard response, then the speed is changed to the one stored. The maximum supported speed is 96 (for bps) Speed Setting B BaseNet Basic Network MM My MAC MAC for Ethernet port Any* ACDE ID DHCP IP Use DHCP for basic network configuration Y or N Y IM Def IP Default IP Address Any* NM Subnet Subnet mask length in bits 1 to GW Gateway Network gateway IP address Any* DN DNS Srvr DNS server IP address Any* MU UDP port Port number for UDP listen Any* 9876 The MAC must be unique on the network. The first 3 bytes (6 hexadecimal digits) of the MAC have been chosen at the factory to be in the private numbering scheme. If there is a network conflict, then simply adding 1 to the last byte will probably resolve the conflict, after a reboot. DHCP is enabled by default. This will attempt to set the device IP address, subnet, gateway and DNS server automatically. If there is a DHCP server on your network, then it will usually assign a dynamic IP address which may change subsequently. Your may turn off DHCP by setting ID to N and setting device IP address, subnet, gateway and DNS server manually, or configure your DHCP server to associate a fixed (static) address with the device MAC. The UDP port number is used to listen for UDP responses for e.g. NTP requests. Innovative Reckoning e4cash Configuration Reference Page 3

4 N NTPsrv Network Time Server Settings ND DHCP? Use DHCP to get NTP settings? N N NI NTP IP NTP Server IP address Any* NP NTP port NTP port number Any* 123 TZ Minutes Timezone minutes East of UTC -720 to NS DNS NT Use DNS for alternate NTP 0 = never 1 = before public NN #Pub NTP Number of public NTP servers listed 0 to 4 4 N0 Pub NTP0 Public NTP server IP address Any* N1 Pub NTP1 Public NTP server IP address Any* N2 Pub NTP2 Public NTP server IP address Any* N3 Pub NTP3 Public NTP server IP address Any* e4cash uses the Network Time Protocol to establish the real date and time for logging events and the microweb interface. It ensures that the correct time is shown. The default NTP server should be a server on the LAN. If you don't have one available, then you may be able to use the NTP server operated by your ISP (Internet Service Provider), making sure that your firewall allows NTP traffic (UDP port 123). If the default NTP server fails to respond, then the DNS server may also be used, as well as a number of public ones on the Internet. 1 L Syslog - Event Logging over the Network DH DHCP Use DHCP to get syslog settings? N N SL IP Syslog server IP address Any* LP Log port Syslog port number Any* 514 FC Facility Syslog facility number Any* 17 AL AlarmSev Syslog alarm severity code Any* 2 WN WarnSev Syslog warning severity code Any* 4 NR NormSev Syslog normal severity code Any* 5 IN InfoSev Syslog informational severity code Any* 6 HN Hostname System name to use in log messages Any* DrawServ Syslog is the name of the network service that provides systems logging. If you have a server that can accept syslog messages (most *nix ones will), then set its IP address here. The facility code of 17 corresponds to the local1 syslog facility on most systems. Innovative Reckoning e4cash Configuration Reference Page 4

5 D Drawer Drawer Settings DI Installd Drawers controlled 0000xxxx DS Switches Switches on drawers 0000xxxx BP BeepOpen Beep when opened 0000xxxx KO KeyOpen Watch for key open (uncommanded) 0000xxxx RC RemClose Remind to close (blink LED & beep) 0000xxxx RD RemDelay Delay seconds before reminder (<10 disables) 10 to CB CableErr Cables to monitor for faults 0000xxxx Most of the drawer settings are bitmaps to identify which drawers are to be controlled, which switches and cables to monitor, etc. The device has the ability to remind the cash drawer user to close the drawer if it's been left open for too long by blinking the corresponding LED indicator and sounding an audible alert (if installed). Bitmap Drawers applied and , 3 and 4 C CtrlSrv Controlling Server Settings and Restrictions CS Command Command server IP address ( disables) Any* CM Cmd MAC Command server MAC (0's disables) Any* PT Cmd port Command server outbound port (0 disables) Any* 0 LS ListenPt Local TCP listen port for commands Any* 7890 Access to e4cash drawer operations can be restricted to one controlling server by either or both IP address and MAC. e4cash will also check that the sending port matches the one specified in the settings. Setting any of the values to zero(s) disable the check of that value. The device listens for drawer commands on the defined listen port. Innovative Reckoning e4cash Configuration Reference Page 5