FRStack WebAPI Service

Raspberry Pi

Install .NET Core 3.1 on RPi

# You should be in your Pi download folder: cd ~/Downloads/

wget <the dot net core download for your RPi device>

# The following website has this info. https://dotnet.microsoft.com/download/dotnet-core/3.1

# Here is the current one for ARM32 devices
# https://download.visualstudio.microsoft.com/download/pr/92e90ed5-dba3-427b-a876-8b46fe5e16b6/69cae4fe4a0ec6bc7585de6fa889fd66/aspnetcore-runtime-3.1.6-linux-arm.tar.gz

# From the Downloads folder, execute the following commands:

sudo mkdir -p /opt/dotnet
sudo tar -zxf aspnetcore-runtime-3.1.5-linux-arm.tar.gz -C /opt/dotnet
sudo ln -s /opt/dotnet/dotnet /usr/bin

Install Node Red on RPi

bash <(curl -sL https://raw.githubusercontent.com/node-red/linux-installers/master/deb/update-nodejs-and-nodered)

See https://nodered.org/docs/getting-started/raspberrypi

Default address for Node Red is http://hostname:1880

Running Node Red on RPi

On pi to run node red in terminal use:

node-red

The following commands are provided to work with the service:

node-red-start - this starts the Node-RED service and displays its log output. Pressing Ctrl-C or closing the window does not stop the service; it keeps running in the background
node-red-stop - this stops the Node-RED service
node-red-restart - this stops and restarts the Node-RED service
node-red-log - this displays the log output of the service

If you want Node-RED to run when the Pi is turned on, or re-booted, you can enable the service to autostart by running the command:

sudo systemctl enable nodered.service

To disable the service, run the command:

sudo systemctl disable nodered.service

Install FRStack WebAPI on RPi

sudo mkdir -p /usr/local/frstack
cd /usr/local/frstack
sudo wget http://www.mkcmsoftware.com/download/FRStackWebApiRpi.zip
sudo unzip FRStackWebApiRpi
# to update specific files from ZIP add the name of the file(s) after the ZIP filename
# for example: sudo unzip FRStackWebApiRpi.zip FRStackWebApi.dll frstackNodeRedV102.json

Run FRStack WebAPI from commandline

dotnet FRStackWebApi.dll --urls "http://*:5025"

Install FRStackWebApi as service

sudo cp FRStackWebApi.service /lib/systemd/system
sudo systemctl daemon-reload 
sudo systemctl enable FRStackWebApi

Note the FRStackWebApi.service contains the port the API will listen on

[Unit]
Description=FRStack Web APIs
After=network.target
 
[Service]
Type=notify
WorkingDirectory=/usr/local/frstack
ExecStart=/usr/bin/dotnet FRStackWebApi.dll --urls "http://*:5025"
Restart=on-failure
 
[Install]
WantedBy=multi-user.target

Start FRStackWebApi service

sudo systemctl start FRStackWebApi 

View FRStackWebApi service status

systemctl status FRStackWebApi

Tail FRStackWebApi service log

journalctl --unit FRStackWebApi --follow

Stop FRStackWebApi service

sudo systemctl stop FRStackWebApi 
systemctl status FRStackWebApi 

Cleaning up FRStackWebApi service

Ensure service is stopped

sudo systemctl stop FRStackWebApi 

Disable the FRStackWebApi service

sudo systemctl disable FRStackWebApi 

Remove and reload SystemD

sudo rm FRStackWebApi.service /lib/systemd/system/FRStackWebApi.service 
sudo systemctl daemon-reload 

Verify SystemD is no longer aware of the FRStackWebApi service

Empty is what we want here

systemctl --type service |& grep FRStackWebApi

Sample Node Red Script

frstackNodeRedV102.json

Configuration

The appSettings.json file contains the startup configuration for the service.

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
      }
    },
  "AllowedHosts": "*",

  "SvcConfig": {
    "AutoConnect": "true",
    "initRadioName": null, // optionally configure the default radio name here to autoconnect to
    "initClientName": null, // optionally configure the default client name to bind to
    "MRUMatchDelta": "0.000999",
    "FollowActiveSlice": "true",
    "MuteOthersOnSliceActive": "true",
    "EnableTxOnSliceActive": "true",
    "TempUnitInF": "true",
    "PgxlTuneStandby": "true",
    "PgxlModeRestore": "true",
    "PgxlRadioMaxPower": "50",
    "PgxlRadioStandbyPower": "100",
    "PGXLOnAntenna": "0", // 0 or 1 or 2
    "RCATXACCTuneDisable": "false",
    "RCATX1TuneDisable": "false",
    "RCATX2TuneDisable": "false",
    "RCATX3TuneDisable": "false",
    "RadioTuneModeDetect": "false",
    "SPEComPort": "",
    "SPETuneStandby": "false",
    "SPEModeRestore": "false",
    "SPEOnAntenna": "0", // 0 or 1 or 2
    "SPEUseDTR": "false",
    "SPEProtocolV1": "false",
    "SPEAutoOpen": "false",
    "SteppIRComPort": "", // port,baud,parity,stop,FollowAntInt,EnabledBool,SyncManualBool,AntTxInhibitInt
    "FDXProtect": "false,false,false,false,false,false", // enabled,ant1,ant2,rxa,rxb,wide
    "UDPSettings": "false,255.255.255.255,12070,false,127.0.0.1,12071,false,127.0.0.1,12072,false,127.0.0.1,12073", // enabled,IPADDR,PORT, enabled,IPADDR,PORT, enabled,IPADDR,PORT, enabled,IPADDR,PORT 
    "UDPMeterSettings": "false,255.255.255.255,12270,false" // enabled,IPADDR,PORT,SMeterEnabled
  }
}

APIs

FRStack Commands
http://localhost:5025/FRStack/{cmd}?param={val}

Radio Commands
http://localhost:5025/Radio/{cmd}?param={val}

Slice / Active Slice Commands
http://localhost:5025/ActiveSlice/{cmd}?param={val}
To target specific slice letter use
http://localhost:5025/Slice/{A-H}/{cmd}?param={val}

SPE Amplifier Slice Commands
http://localhost:5025/SPEAMP/{cmd}?param={val}

SteppIR Commands
http://localhost:5025/STEPPIR/{cmd}?param={val}

Note:

• FREQANT, FREQE, SYNC can only be used when CAT cable is not used.
• OPEN with param=1 will connect to COM port then send the 'R' Wake / Turn on Serial frequency update command
• RETRACT will send 'U' Turn off Serial frequency update then 'S' Home antenna

Meter information over WebSocket

http://localhost:5025/ws/meters

Json Data returned

{
 "station":"6600M",
 "callsign":"W3II",
 "nickname":"6600M",
 "ipaddr":"192.168.1.202",
 "meters":{
    "+13.8A":"14.2",
    "PATEMPC":"32.1",
    "FWDPWR":"0.0",
    "REVPWR":"0.0",
    "SWR":"1.0",
    "AMP PWR":"0",
    "AMP ID":"0",
    "AMP SWR":"1.1",
    "AMP TEMPC":"30.2",
    "AMP TEMPF":"86.3",
    "PATEMPF":"89.8"}
}