ToogleSwitch Class

From FlightGear wiki
Jump to navigation Jump to search
FG Int Switches Classes

Navigation

Switches Class ToogleSwitch will be used to manage standard push button (momentary switch - only 1 input needed per switch) and is based on the MCP23017.

Switches Configuration File

Displays configuration file : /opt/fgint/Config/Pedestal/tglswitches.cfg

This file describes the TRANSFERT push button on the RMP Panel installed on the Pedestal.

There are two separate parts in this file.

  1. a general configuration part, in the CONF and PROPERTIES sections.
  2. the other sections each describe a display.
[CONF]
confname=TGLSWITCHES
library=FGIntSwitch
module=ToogleSwitch
properylist=device,name,port,pin,values,valuestype,initstate,checknode,node

[PROPERTIES]
prop01=device
prop02=name
prop03=port
prop04=pin
prop05=values
prop06=valuestype
prop07=initstate
prop08=checknode
prop09=node

[RMP0TRSW]
name=rmp0trsw
device=IOPACK1
port=B
pin=1
values=0,1
valuestype=int
initstate=0
checknode=0
node=/fgint/radiopanel/rmp[0]/transfersw

CONF Section

The CONF describe what type of object are describe here and how they will be built.

  • confname : Nothing special here, just a name to set about what we are talking about.
  • library : FG Interface python library from which the class will be loaded.
  • module : Module name (Class name) in the library file that will be loaded. Here we are using the Switch Class
  • propertylist : List of parameter that are needed to create a switch object.

PROPERTIES Section

Properties section is defined to declare and order each parameter that is needed to create the elements (Super Class FGInt ToogleSwitches in that case, take some parameters to create a switch object, as the input where the switch is connected on the interface). This is how the interface will be able to understand and use the switch configurations to create them.

For Switches, to create one, you will need to provide for each required parameters. And the section gives the order in which the parameters will be called when creating the object.

[PROPERTIES]
prop01=device      # Device Logical Name
prop02=name        # Switch Name
prop03=port        # MCP23017 port where the switch is connected
prop04=pin         # MCP23017 input where the switch is connected
prop05=values      # Values that will be provided for the switch state
prop06=valuestype  # Typed Values that is used with this switch
prop07=initstate   # Value for initial state
prop07=checknode   # Actually not use. Set to 0
prop08=node        # FG Property that is manage by the switch

In PROPERTIES section, you have to provide parameters name and in which order. With this, FG interface just have to read parameters for each object and use them to create each object.

Creating Switches

The order of the parameters does not fall from the sky. If we look more closely at the Class "Switch" in the FGIntSwitch.py

class ToogleSwitch:
    """
    Toogle Switch
    """

    ###############
    # Properties
    ###############

    ###############
    # Constructor
    ###############
    def __init__(self, device, name, port, pin, values, valuestype, initstate, checknode, node, debug=0):

here how switches should be instantiated: To create a toogle switch with this class you have to call :

ToogleSwitch(device, name, port, pin, values, valuestype, initstate, checknode, node, [debug])

"debug" is not mandatory. If not provide, il will be automaticly set to 0

But as already explained several times, you should not have to call this method directly. In normal operation, the objects will be created via the methods of the interface itself (with the createElement() and/or createElements() methods)

Toogle Switches Methods

getName()

Return the switch Name according the configuration

Python 3.7.3 (default, Jan 22 2021, 20:04:44)
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from FGInterface import FGInterface as FGINT
>>> FGINT1 = FGINT('overheadpanel.cfg')
>>> FGINT1.createDevices()
>>> FGINT1.createElements()
>>> RMP0TRSW = FGINT1.getElement('RMP0TRSW')
>>> RMP0TRSW.getName()
'rmp0trsw'
>>>

getMillis()

Return number of milisecond spent between the current time and the time define in the timestamp switch property. The timestamp property is updated internaly each time the toogle switch state change.

Remember that it's the toogle switch state that is sent to sim, not the pin state. Each time the pin is set to 1, the switch state is updated.

Python 3.7.3 (default, Jan 22 2021, 20:04:44)
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from FGInterface import FGInterface as FGINT
>>> FGINT1 = FGINT('overheadpanel.cfg')
>>> FGINT1.createDevices()
>>> FGINT1.createElements()
>>> RMP0TRSW = FGINT1.getElement('RMP0TRSW')
>>> RMP0TRSW.getMillis()
35940.058
>>> RMP0TRSW.getMillis()
37063.936
>>> RMP0TRSW.getMillis()
38351.924
>>> RMP0TRSW.getMillis()
39441.908
>>> RMP0TRSW.getMillis()
47510.832
>>>

as you can see, invoking the getMillis() methode without doing anything, the value still grow

getValueType()

Return the type of value that is used witch this switch. Can be bool (boolean), int (integer) or string (string) according with the configuration file.

Python 3.7.3 (default, Jan 22 2021, 20:04:44)
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from FGInterface import FGInterface as FGINT
>>> FGINT1 = FGINT('overheadpanel.cfg')
>>> FGINT1.createDevices()
>>> FGINT1.createElements()
>>> RMP0TRSW = FGINT1.getElement('RMP0TRSW')
>>> RMP0TRSW.getValueType()
'int'
>>>

getValueType()

Python 3.7.3 (default, Jan 22 2021, 20:04:44)
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from FGInterface import FGInterface as FGINT
>>> FGINT1 = FGINT('overheadpanel.cfg')
>>> FGINT1.createDevices()
>>> FGINT1.createElements()
>>> RMP0TRSW = FGINT1.getElement('RMP0TRSW')
>>> RMP0TRSW.getValueType()
'int'
>>>

getNode()

Return the node that is manage by the switch according the configuration file.

Python 3.7.3 (default, Jan 22 2021, 20:04:44)
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from FGInterface import FGInterface as FGINT
>>> FGINT1 = FGINT('overheadpanel.cfg')
>>> FGINT1.createDevices()
>>> FGINT1.createElements()
>>> RMP0TRSW = FGINT1.getElement('RMP0TRSW')
>>> RMP0TRSW.getNode()
'/fgint/radiopanel/rmp[0]/transfersw'
>>>

getTypedData()

Return the typed value given as agument according to what have been set in the valuestype property

Python 3.7.3 (default, Jan 22 2021, 20:04:44)
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from FGInterface import FGInterface as FGINT
>>> FGINT1 = FGINT('overheadpanel.cfg')
>>> FGINT1.createDevices()
>>> FGINT1.createElements()
>>> RMP0TRSW = FGINT1.getElement('RMP0TRSW')
>>> RMP0TRSW.getTypedData('1')
1
>>> RMP0TRSW.getTypedData('0')
0
>>>

getInputState()

Return the actual pin state of the switch by reading the I/O Device

Button released

Python 3.7.3 (default, Jan 22 2021, 20:04:44)
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from FGInterface import FGInterface as FGINT
>>> FGINT1 = FGINT('overheadpanel.cfg')
>>> FGINT1.createDevices()
>>> FGINT1.createElements()
>>> RMP0TRSW = FGINT1.getElement('RMP0TRSW')
>>> RMP0TRSW.getInputState()
0
>>>

Button maintained pushed

>>> RMP0TRSW.getInputState()
1
>>>

getSwitchState()

Return the actual state of the switch

Python 3.7.3 (default, Jan 22 2021, 20:04:44)
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from FGInterface import FGInterface as FGINT
>>> FGINT1 = FGINT('overheadpanel.cfg')
>>> FGINT1.createDevices()
>>> FGINT1.createElements()
>>> RMP0PWSW = FGINT1.getElement('RMP0PWSW')
>>> RMP0PWSW.getSwitchState()
'0'
>>> RMP0TRSW.getSwitchState()
0

Set the switch 'On' on the panel

>>> RMP0PWSW.getSwitchState()
'1'
>>> RMP0TRSW.getSwitchState()
0

Combined with the value typing function

>>> RMP0PWSW.getTypedData(RMP0PWSW.getSwitchState())
1
>>> RMP0PWSW.getTypedData(RMP0PWSW.getSwitchState())
0
>>>

ToogleState()

Flip the switch state according to configuration value

Python 3.7.3 (default, Jan 22 2021, 20:04:44)
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from FGInterface import FGInterface as FGINT
>>> FGINT1 = FGINT('overheadpanel.cfg')
>>> FGINT1.createDevices()
>>> FGINT1.createElements()
>>> RMP0PWSW = FGINT1.getElement('RMP0PWSW')
>>> RMP0TRSW.getSwitchState()
0
>>> RMP0TRSW.ToogleState()
>>> RMP0TRSW.getSwitchState()
1
>>> RMP0TRSW.ToogleState()
>>> RMP0TRSW.getSwitchState()
0
>>>
Retrieved from "https://wiki.flightgear.org/w/index.php?title=ToogleSwitch_Class&oldid=135457"