HamSphere 4.0 Interface Adapter Users Manual

HamSphere 4.0

INTERFACE ADAPTER

Users Manual v.1.2

1. Introduction

2. Assigning keys

3. Assigned values

4. Assigning Com Port signals

5. Load and Save files

6. Pitfalls

7. List Assigned functions

8. HamSphere Plugin/Function list

9. Com Code list

10. Key Code list

11. Antenna list

1. Introduction

Thank you for purchasing the versatile Interface Adapter plugin for HamSphere 4.0. The purpose of the module is to tie Keyboard Keys to different functions in the HamSphere

4.0 transceiver and plugins. It also has a fully fledged RS232 interface/adapter making connection to external hardware possible.

The schematic view of the HamSphere 4.0 external interfacing. A table called “Registered Functions” is held in the transceiver’s memory. Each Plugin can register its functionality for external access in the table. The Interface

Adapter can then read the table and access the functions and tie these to either keys or com port signals.

By clicking the key you can easily find the wanted functionality and set its parameters. All settings are automatically saved in the rig’s memory, but you can also export a so called “Key setting file” that can be distributed to other HamSphere 4.0 users for fast implementation.

2. Assigning keys

Start by clicking “Assign” and it will bring up the Function assign window.

You can now click any key you want to use. Here as an example we click the F12 key and the Input selector automatically identifies the key and selects it:

Next step is to select a function from the function list. Here we select IHS6 which is PTT. IHS stands for (Internal HamSphere

System) and means that you are requesting a standardized function in the HamSphere subsystem. Click OK to save.

Now you have “assigned” F12 to trigger PTT when pressed.

3. Assigning Values

Some functions require values to be set. As an example we will assign the minus key to step 10 Hz. Just bring up the Assign window and click the minus key on the keyboard. The system automatically finds the key in the list (VK_SUBTRACT). Then browse down to the IHS9 Increment/decrement QR/TX QRG and enter a value of

-10. Then click OK.

Now whenever/wherever you click the Minus key, the transceiver will tune 10 Hz down.

You can also assign static values such as “Set Speaker Off” by assigning 0 to ISH7 Set Volume. The example below we have assigned the F11 key to set the volume off.

4. Assigning Com Port signals

There are many USB-Serial interfaces available in the market. The interface cable or dongle is primarily what is called a "USB-UART Bridge". It will create a Virtual COM Port on your system. Since most modern computers do not feature hardware legacy serial port interfaces (COM ports) anymore, the only alternative is to use the USB port on the machine to emulate a COM port. An interface cable/dongle essentially has a special chip in it that performs the required USB to UART interface conversion. Some of the popular chips used are FTDI FT232R/RL, Prolific PL2303/XA/XHA/TA/TB/EA/RA/SA, SiLabs

CP21xx series or Microchip MC2200, etc. Other than this, another chip is required for converting UART TTL levels to RS232 Serial Port protocol standards. For this, the most popular and widely used chip is Maxim MAX232 or MAX3232. Unlike TTL, the RS232 has +/-12V logic levels. However commercially available cheap RS232 implementations often may not have +/-12V but as low as +/-3V logic levels. In our use with the CW plugin, these levels do not really matter. We have tested and validated the plugin compatibility with cables and interfaces using all the above mentioned chips. Our Interface Adapter plugin works perfectly.

The DB9 RS232 interface consists of 9 pin male connector on the USB-Serial cable. The cable behaves like a native hardware COM port interface of the computer (DTE - Data

Terminal Equipment). There are 2 data pins called RxD and TxD for transmitting and receiving serial data over RS232. There is also 1 ground pin. Rest of the pins are for controlling communication over the serial data link and are called "Flow Control" pins

These pins are DCD, DTR, DSR, RTS, CTS and RI. We need not go into details of these

Flow Control pins.

BEWARE of the following selection pitfalls:

1) We find several USB-Serial cables in the market that do not faithfully implement the

Flow Control logic. They may work fine with many of your computer serial port applications but they won't work with our plugin. They are only suitable for Xon/Xoff software flow control serial communication applications.

2) Two flow control pins DCD (Data Carrier Detector) and RI (Ring Indicator) are now treated as legacy functions and are not really needed even for proper hardware flow control. They were only needed during the days of PPP dial-up internet modems. Since that is all history, many of these cables do not implement these pins properly... However, our plugin requires RI pin to function, please ensure that the cable you buy has RI (pin

#9) implemented. You need not bother about DCD (pin #1).

3) If your cable/dongle is built using the Prolific PL2303 chip, you must ensure that it comes from a proper source. We are putting out this warning because there are many clones of this chip that are made in China. These imitations do not perform well. In worst case, they may not even be supported by the original Microsoft signed drivers. They will throw up a Yellow mark and “Error Code 10” on the driver under Device Manager.

4) The Prolific chip is very popular and the market is flooded with cables based on these chips. Those who run Windows 8/8.1, please note that cables made using

PL2303/H/HX/XA/HXA do not support your operating system. However they are good up to Windows 7 (32bit and 64bit), but PL3203/H does not even support Windows 7 64 bit...

All newer PL2303 versions TA/TB/EA/RA/SA are good for all Windows versions.

Most of the cables will automatically install Virtual Serial Port drivers on your computer transparently, if the Windows Update is active and you are connected to the Internet.

Some of them may however require driver installation. This is a trivial task. You may be provided with a driver CD along with the cable or can download it from the chip manufacturer's website.

Lastly, please remember to add pull-up resistors (In this case pull-down) as specified by drawing below. This is necessary because of the nature of CMOS/NMOS input logic. If you fail to use the pull-up resistors then the voltage at the input pins will float up and down due to charge accumulation or dissipation resulting in false keying and tone generation by the plugin. Floating input pins are never permitted in CMOS circuits unlike

TTL, where an open input always means high logic level.

In our case we feed the Paddle/Key with positive voltage from RTS (Request To Send) and pull the inputs to Ground by two 4.7 kohm resistors.

RS232 Text provided by Basu (VU2NSB)

Installation of the USB driver

Most USB adapters install their own driver by default. Normally you do not need to do any work for this. But as stated in the description, there are quite a few bad USB adapters out there that may not install correctly. Here is an example of A BAD Prolific PL3202 cable installation...

This is what is should look like. A GOOD Prolific PL3202 cable installation...

The USB RS232 is usually sold as a cable seen below.

But there are many variants with ready 9-pin connections.

You can use a 9-pin patch terminal to connect your CW Key or other equipment.

Assigning Com Port signals

Click ASSIGN on the Interface Adapter and select a COM

PORT signal such as the CTS signal (COM_CTS). If you have the CW Keyer plugin installed (INT010) it will turn up as

[INT010A] Set Left Paddle in the Function selector. Simply select that and press OK.

Now your left paddle key is connected to the CW Keyer left paddle function = IAMBIC Dits. Then do the same for the

COM_DSR and assign that to the right paddle = IAMBIC Dash.

If you use a straight key you can select either of the left or right paddle inputs.

5. Load and Save files

The Interface Adapter can save a load separate Keyboard / Com port setting files. This is most useful for pre-made CAT-Interface settings or operators sharing Keyboard settings.

Operators can easily set up a suitable keyboard layout for the HamSphere 4.0 transceiver and distribute their settings to other operators etc.

Click SET button on the Interface Adapter. When loading files the system looks that the file extension key.txt or com.txt to determine what function to load.

6. Pitfalls

The Interface Adapter uses a so called “Global Key Handler”.

This means that even if you have HamSphere 4.0 running in the background it will listen for keyboard input.

Some operators may find keying the transmitter with the space key very useful. The problem is however that the space key is used everywhere in the computer today. It is used in anything from writing emails, checking facebook or writing a document.

We therefore strongly suggest that you assign keys that are not usually used in common text applications such as F1-F12, keypad, function keys etc.

In the current version of the Interface Adapter it only supports

F1-F12. But in later version we will implement CTRL+F1-F12 and ALT+F1-F12 which will enable a lot more suitable keys.

7. List assigned functions

By selecting the “List Assigned Functions” in the Set window, a list of assigned keys/com is printed in the DX Monitor window.

This is very useful when you want to find available keys. The list consists of the Key code/Com signal, Plugin ID and Value.

8. HamSphere Plugin/Function list

Plugin ID Plugin Name

ACT004 Antenna Rotator 216x72

ATC001 Antenna Rotator 216x288

ATC002 Antenna Rotator 216x216

ATC003 Antenna Selector 216x144

AUC001 Audio Control 216x72

AUC003 Filter Panel 216x72

AUC004 Mini Mic Pwr 216x72

AUC005 Mini Volume 216x72

AUC007 Volume Panel Vert 72x432

AUC007 Volume Panel 432x72

AUC008 Recorder 432x72

AUD002 Speaker 216x288

BSW001 Band Selector 216x144

BSW002 Button Panel 216x216


BSW004 Group Switcher 648x432

BSW005 VFO 216x216


BSW008 Codec Selector 216x72

BSW009 Interface Adapter 216x72

BSW010 BC Panel 216x72

CPL001 Copyright Plate 216x72

CPL002 Cover Plate 216x144










No

No

No

No

No

No

Yes

Yes

No

Yes

No

No

No

No

No

No

No

No

No

No

No

No

No

No

No

No

No

No

Offering functions

(Subject to change)

No

No

Yes

Yes







CPL019 Lightup Callsign 216x72

CPL020 Custom Nameplate 648x72

CPL021 Custom Nameplate 432x72

HND001 Left Handle 72x288





HND006 Right Handle 72x288





INS001 Band Scope 432x144

INS002 LCD 216x144

INS003

INS004

INS005

INS006

INS007

INS008

INS009

INS010

LCD Memory 432x144

Oscilloscope 216x144

S-Meter 216x144

S-Meter LCD 216x144

S-Meter Plus 216x144

UTC Clock 216x72

Azimuth Display 216x72

Power Display 216x72

INS011

INS012

INT001

INT002

INT003

INT004

INT010

Waterfall 432x144

S-Meter Lit 216x144

DX Monitor 216x360

Log Book 648x360

DX Monitor 216x432

Lookup Box 216x72

CW Keyer 216x72

MOD001 HF Propagation 216x360

No

No

No

No

No

No

No

No

No

No

No

No

No

No

No

No

No

No

No

No

No

No

No

No

No

No

No

Yes

No

No

No

No

No

No

No

No

No

MOD002 Image Viewer 648x360

MOD003 Grayline Map 432x144

Internal HamSphere Functions (IHS)

Function Description

IHS1

IHS2

Set RX Freq 1000-99000

Set TX Freq 1000-99000

IHS3 Set Mode (0-3)

IHS4 Set Band (1-15)

IHS5 Set Filter (0-7)

No

No

Values

1000-99000

1000-99000

CW = 0

LSB = 1

USB = 2

FM = 3

1 = 160m

2 = 80m

3 = 60m

4 = 48m

5 = 40m

6 = 30m

7 = 20m

8 = 17m

9 = 15m

10 = 12m

11 = 11m

12 = 10m

13 = 6m

14 = 2m

15 = 70cm

0 = 3.2 wide

1 = 2.8

2 = 2.3

3 = 1.8

4 = 1.4

5 = 0.8

6 = CW1

7 = CW2

IHS6

IHS7

IHS8

IHS9

IHS10

IHS11

IHS12

IHS13

IHS14

IHS15

IHS16

Set PTT

Set Volume

Set RF Gain

0-255

0-255

Increment/decrement RX/TX QRG +/- Hz

RX/TX frequency in Hz

Set AGC

Set VOX Delay

Set VOX Gain

Set VOX

1801000-

434900000

0 Fast

1 Medium

2 Slow

0-255

0-255

Set Power

Set Mic Level

0 = Off

1 = On

0-255 = 0-100

Watts

0-255

12. Com Code list

Com Code Description

COM_CTS Clear To Send

COM_DSR

COM_RTS

COM_DTR

COM_RI

Data Set Ready

Request To Send

Data Terminal Ready

Ring Indicator

COM_CD

COM_CAT1

COM_CAT2

COM_CAT3

COM_CAT4

COM_CAT5

COM_CAT6

COM_CAT7

COM_CAT8

Carrier Detect

Reserved CAT command








COM_CAT9 Reserved CAT command











10. Key Code list

VK_0

VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39)

VK_1

VK_2

VK_3

VK_4

VK_5

VK_6

VK_7

VK_8

VK_9

VK_A

VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A)

VK_ACCEPT

Constant for the Accept or Commit function key.

VK_ADD

VK_AGAIN

VK_ALL_CANDIDATES

Constant for the All Candidates function key.

VK_ALPHANUMERIC

Constant for the Alphanumeric function key.

VK_ALT

VK_ALT_GRAPH

Constant for the AltGraph function key.

VK_AMPERSAND

VK_ASTERISK

VK_AT

Constant for the "@" key.

VK_B

VK_BACK_QUOTE

VK_BACK_SLASH

Constant for the back slash key, "\"

VK_BACK_SPACE

VK_BEGIN

Constant for the Begin key.

VK_BRACELEFT

VK_BRACERIGHT

VK_C

VK_CANCEL

VK_CAPS_LOCK

VK_CIRCUMFLEX

Constant for the "^" key.

VK_CLEAR

VK_CLOSE_BRACKET

Constant for the close bracket key, "]"

VK_CODE_INPUT

Constant for the Code Input function key.

VK_COLON

Constant for the ":" key.

VK_COMMA

Constant for the comma key, ","

VK_COMPOSE

Constant for the Compose function key.

VK_CONTEXT_MENU

Constant for the Microsoft Windows Context Menu key.

VK_CONTROL

VK_CONVERT

Constant for the Convert function key.

VK_COPY

VK_CUT

VK_D

VK_DEAD_ABOVEDOT

VK_DEAD_ABOVERING

VK_DEAD_ACUTE

VK_DEAD_BREVE

VK_DEAD_CARON

VK_DEAD_CEDILLA

VK_DEAD_CIRCUMFLEX

VK_DEAD_DIAERESIS

VK_DEAD_DOUBLEACUTE

VK_DEAD_GRAVE

VK_DEAD_IOTA

VK_DEAD_MACRON

VK_DEAD_OGONEK

VK_DEAD_SEMIVOICED_SOUND

VK_DEAD_TILDE

VK_DEAD_VOICED_SOUND

VK_DECIMAL

VK_DELETE

VK_DIVIDE

VK_DOLLAR

Constant for the "$" key.

VK_DOWN

Constant for the non-numpad

down

arrow key.

VK_E

VK_END

VK_ENTER

VK_EQUALS

Constant for the equals key, "="

VK_ESCAPE

VK_EURO_SIGN

Constant for the Euro currency sign key.

VK_EXCLAMATION_MARK

Constant for the "!" key.

VK_F

VK_F1

Constant for the F1 function key.

VK_F10


VK_F11


VK_F12


VK_F13


VK_F14


VK_F15


VK_F16


VK_F17


VK_F18


VK_F19


VK_F2


VK_F20


VK_F21


VK_F22


VK_F23


VK_F24


VK_F3


VK_F4


VK_F5


VK_F6


VK_F7


VK_F8


VK_F9


VK_FINAL

VK_FIND

VK_FULL_WIDTH

Constant for the Full-Width Characters function key.

VK_G

VK_GREATER

VK_H

VK_HALF_WIDTH

Constant for the Half-Width Characters function key.

VK_HELP

VK_HIRAGANA

Constant for the Hiragana function key.

VK_HOME

VK_I

VK_INPUT_METHOD_ON_OFF

Constant for the input method on/off key.

VK_INSERT

VK_INVERTED_EXCLAMATION_MARK

Constant for the inverted exclamation mark key.

VK_J

VK_JAPANESE_HIRAGANA

Constant for the Japanese-Hiragana function key.

VK_JAPANESE_KATAKANA

Constant for the Japanese-Katakana function key.

VK_JAPANESE_ROMAN

Constant for the Japanese-Roman function key.

VK_K

VK_KANA

VK_KANA_LOCK

Constant for the locking Kana function key.

VK_KANJI

VK_KATAKANA

Constant for the Katakana function key.

VK_KP_DOWN

Constant for the numeric keypad

down

arrow key.

VK_KP_LEFT


left

arrow key.

VK_KP_RIGHT


right

arrow key.

VK_KP_UP


up

arrow key.

VK_L

VK_LEFT


left

arrow key.

VK_LEFT_PARENTHESIS

Constant for the "(" key.

VK_LESS

VK_M

VK_META

VK_MINUS

Constant for the minus key, "-"

VK_MODECHANGE

VK_MULTIPLY

VK_N

VK_NONCONVERT

Constant for the Don't Convert function key.

VK_NUM_LOCK

VK_NUMBER_SIGN

Constant for the "#" key.

VK_NUMPAD0

VK_NUMPAD1

VK_NUMPAD2

VK_NUMPAD3

VK_NUMPAD4

VK_NUMPAD5

VK_NUMPAD6

VK_NUMPAD7

VK_NUMPAD8

VK_NUMPAD9

VK_O

VK_OPEN_BRACKET

Constant for the open bracket key, "["

VK_P

VK_PAGE_DOWN

VK_PAGE_UP

VK_PASTE

VK_PAUSE

VK_PERIOD

Constant for the period key, "."

VK_PLUS

Constant for the "+" key.

VK_PREVIOUS_CANDIDATE

Constant for the Previous Candidate function key.

VK_PRINTSCREEN

VK_PROPS

VK_Q

VK_QUOTE

VK_QUOTEDBL

VK_R

VK_RIGHT


right

arrow key.

VK_RIGHT_PARENTHESIS

Constant for the ")" key.

VK_ROMAN_CHARACTERS

Constant for the Roman Characters function key.

VK_S

VK_SCROLL_LOCK

VK_SEMICOLON

Constant for the semicolon key, ";"

VK_SEPARATER

This constant is obsolete, and is included only for backwards compatibility.

VK_SEPARATOR

Constant for the Numpad Separator key.

VK_SHIFT

VK_SLASH

Constant for the forward slash key, "/"

VK_SPACE

VK_STOP

VK_SUBTRACT

VK_T

VK_TAB

VK_U

VK_UNDEFINED

This value is used to indicate that the keyCode is unknown.

VK_UNDERSCORE

Constant for the "_" key.

VK_UNDO

VK_UP


up

arrow key.

VK_V

VK_W

VK_WINDOWS

Constant for the Microsoft Windows "Windows" key.

VK_X

VK_Y

VK_Z

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

11. Antenna list

1 10-meter Yagi 8 elements at 35' above average ground

25

26

27

28

29

30

31

15

16

17

18

19

20

21

22

23

24

2

3

4

5

6

7

8

9

10

11

12

13

14

40-meter Yagi 8 elements at 100ft above average ground

15-meter 3-element high-gain quad at 95ft above average ground

135ft 30-degree inverted-V, 40 meters, 55ft above average ground

165 ft terminated folded dipole, 160 meters, 95 ft above avg ground

17-meter 6-element quad at 95ft above average ground

20-meter Yagi 8 elements at 95' above average ground

GP Monopole with 256 Radials (20m)

1/4-wl monopole with 4 radials elevated 20' above ground, 20m

20-meter 6-element quad at 95' above average ground

G5RV Dipole (10-80m)









NVIS antenna for 160m with extremely good ground


15-meter Yagi 8 elements at 95' above average ground

80-meter Yagi 8 elements at 75ft above average ground' above GND

Equilateral Delta Loop for 40m with 30ft base height

Half Square for 40m with 10ft base height, very good ground

Lazy-H multi-band for 10, 15, 20 and 40m, 88ft x 44ft, 95ft ab. GND.

IDC Vertical Antenna (10-40m)

H-Quad Loop (10-80m)

40-meter Yagi 3 elements short boom at 100ft above average ground

40-meter Yagi 2 elements driver-reflector at 100ft above avg GND

4-square array monopoles for 40m, very good ground

4-square array monopoles for 80m, very good ground

Cardioid Antenna (20m)

Cardioid Antenna (40m)

Vertical Co-phased Collinear (20m)

Vertical Co-phased Collinear (40m)

8-element Yagi at 95 ft (12m)




IDC Vertical Antenna (160-48m)




3 Element Yagi for 10m at 95 feet height











86

87

88

89

90

91

92

93

94

78

79

80

81

82

83

84

85

68

69

70

71

72

73

74

75

76

77

56

57

58

59

60

61

62

63

64

65

66

67

105

106

107

108

109

110

111

112

113

114

95

96

97

98

99

100

101

102

103

104


Tri-band Dipole 10m @ 33ft: Freq=28.45 MHz

Dipole 15m @ 33 ft

Dipole 20m @ 33 ft

Dipole 60m @ 132 ft

Dipole 80m @ 132 ft

Dipole 160m @ 132 ft










4-5el Quad at 66ft (10m)







Cardioid (10m)

Cardioid (11m)

Cardioid (12m)

Cardioid (15m)

Cardioid (17m)

Cardioid (20m)

Cardioid (30m)

Cardioid (40m)

Cardioid (48m)

Cardioid (60m)

Cardioid (80m)

Cardioid (160m)

Inverted-V Dipole @ 45 f (11m)

Inverted-V Dipole @ 66 ft (40m)

2 el Fan Dipole Yagi @ 70 ft (10m)






5 bands 2-el Fan Dipole yagi (10, 12, 15, 17 and 20m)

6 bands 4-5el Quad at 66ft (10, 11, 12, 15, 17 and 20m)

Tri-band Dipole 20-15-10 @ 33ft

Tri-band Dipole 160-80-60 @ 132ft

IDC Vertical (10-160m)

VColMon (Not Active)

Beverage 300m very good ground (80, 60, 48 and 40m)

Super Beverage 160m, 3600m



Super Beverage 3200m

V-Collinear (10m)

V-Collinear (12m)

V-Collinear (15m)

V-Collinear (17m)

V-Collinear (30m)

115 BC Phased Array

116 VU2NSB OmniDX Array







HamSphere 4.0 Interface Adapter Users Manual

Assistant Bot

HamSphere 4.0

INTERFACE ADAPTER

Users Manual v.1.2

1. Introduction

2. Assigning keys

3. Assigned values

4. Assigning Com Port signals

5. Load and Save files

6. Pitfalls

7. List Assigned functions

8. HamSphere Plugin/Function list

9. Com Code list

10. Key Code list

11. Antenna list

1. Introduction

2. Assigning keys

3. Assigning Values

4. Assigning Com Port signals

Installation of the USB driver

Assigning Com Port signals

5. Load and Save files

6. Pitfalls

7. List assigned functions

8. HamSphere Plugin/Function list

12. Com Code list

10. Key Code list

11. Antenna list

Key Features

Frequently Answers and Questions

How do I assign a key to a function?

Can I assign values to functions?

What COM port signals are supported?

How do I load and save key settings?

What are some pitfalls to avoid when using the Interface Adapter?

Related manuals

HamSphere 4.0 Interface Adapter Users Manual

Assistant Bot

HamSphere 4.0

INTERFACE ADAPTER

Users Manual v.1.2

1. Introduction

2. Assigning keys

3. Assigned values

4. Assigning Com Port signals

5. Load and Save files

6. Pitfalls

7. List Assigned functions

8. HamSphere Plugin/Function list

9. Com Code list

10. Key Code list

11. Antenna list

1. Introduction

2. Assigning keys

3. Assigning Values

4. Assigning Com Port signals

Installation of the USB driver

Assigning Com Port signals

5. Load and Save files

6. Pitfalls

7. List assigned functions

8. HamSphere Plugin/Function list

12. Com Code list

10. Key Code list

11. Antenna list

Key Features

Frequently Answers and Questions

How do I assign a key to a function?

Can I assign values to functions?

What COM port signals are supported?

How do I load and save key settings?

What are some pitfalls to avoid when using the Interface Adapter?

Related manuals

HamSphere

4.0

ThunderMax

USB-SERIAL driver

M2 Antenna

40-20M-3-5

Japan Radio

5/8-wave

Japan Radio

10dBi Collinear array phased 1/2-wave

microHAM

STATION MASTER

Cubietech

1 or 2

SteppIR

3 Element

SteppIR

DIPOLE

SteppIR

DB36