1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934
|
package pactor
import (
"bufio"
"bytes"
"encoding/binary"
"encoding/hex"
"errors"
"fmt"
"math/bits"
"net"
"os"
"strconv"
"strings"
"sync"
"time"
"github.com/albenik/go-serial/v2"
"github.com/howeyc/crc16"
)
const network = "pactor"
type Addr struct{ string }
type cstate struct {
a int
b int
c int
d int
e int
f int
}
type pflags struct {
exit bool
closeCalled bool
closed bool
disconnected chan struct{}
connected chan struct{}
closeWriting chan struct{}
}
type pmux struct {
device sync.Mutex
pactor sync.Mutex
write sync.Mutex
read sync.Mutex
close sync.Mutex
bufLen sync.Mutex
}
type Modem struct {
devicePath string
localAddr string
remoteAddr string
state State
stateOld State
device *serial.Port
mux pmux
wg sync.WaitGroup
flags pflags
channelState cstate
goodChunks int
recvBuf chan []byte
cmdBuf chan string
sendBuf chan byte
sendBufLen int
packetcounter bool
}
func (p *Modem) SetDeadline(t time.Time) error { return nil }
func (p *Modem) SetReadDeadline(t time.Time) error { return nil }
func (p *Modem) SetWriteDeadline(t time.Time) error { return nil }
func (a Addr) Network() string { return network }
func (a Addr) String() string { return a.string }
func (p *Modem) RemoteAddr() net.Addr { return Addr{p.remoteAddr} }
func (p *Modem) LocalAddr() net.Addr { return Addr{p.localAddr} }
// Initialise the pactor modem and all variables. Switch the modem into hostmode.
// Start the link setup.
//
// Will abort if modem reports failed link setup, Close() is called or timeout
// has occured (90 seconds)
func OpenModem(path string, baudRate int, myCall string, initScript string, cmdlineinit string) (p *Modem, err error) {
p = &Modem{
// Initialise variables
devicePath: path,
localAddr: myCall,
remoteAddr: "",
state: Unknown,
stateOld: Unknown,
device: nil,
flags: pflags{
exit: false,
closeCalled: false,
disconnected: make(chan struct{}, 1),
connected: make(chan struct{}, 1),
closeWriting: make(chan struct{})},
channelState: cstate{a: 0, b: 0, c: 0, d: 0, e: 0, f: 0},
goodChunks: 0,
recvBuf: make(chan []byte, 0),
cmdBuf: make(chan string, 0),
sendBuf: make(chan byte, MaxSendData),
sendBufLen: 0,
}
writeDebug("Initialising pactor modem", 1)
if err := p.checkSerialDevice(); err != nil {
writeDebug(err.Error(), 1)
return nil, err
}
//Setup serial device
if p.device, err = serial.Open(p.devicePath, serial.WithBaudrate(baudRate), serial.WithReadTimeout(SerialTimeout)); err != nil {
writeDebug(err.Error(), 1)
return nil, err
}
p.hostmodeQuit() // throws error if not in hostmode (e.g. from previous connection)
if _, _, err = p.writeAndGetResponse("", -1, false, 10240); err != nil {
return nil, err
}
// Make sure, modem is in main menu. Will respose with "ERROR:" when already in
// main menu!
_, _, err = p.writeAndGetResponse("Quit", -1, false, 1024)
if err != nil {
return nil, err
}
writeDebug("Running init commands", 1)
ct := time.Now()
commands := []string{"MYcall " + p.localAddr, "PTCH " + strconv.Itoa(PactorChannel),
"MAXE 35", "REM 0", "CHOB 0",
"TONES 4", "MARK 1600", "SPACE 1400", "CWID 0", "CONType 3", "MODE 0",
"DATE "+ct.Format("020106"), "TIME "+ct.Format("150405")}
//run additional commands provided on the command line with "init"
if cmdlineinit != "" {
for _, command := range strings.Split(strings.TrimSuffix(cmdlineinit, "\n"), "\n") {
commands = append(commands, command)
}
}
for _, cmd := range commands {
var res string
_, res, err = p.writeAndGetResponse(cmd, -1, false, 1024)
if err != nil {
return nil, err
}
if strings.Contains(res, "ERROR") {
return nil, fmt.Errorf(`Command "` + cmd + `" not accepted: ` + res)
}
}
// run additional commands stored in the init script file
if initScript != "" {
if err = p.runInitScript(initScript); err != nil {
return nil, err
}
}
p.hostmodeStart() // throws error when switching successfully to hostmode
if err = p.runControlLoops(); err != nil {
return nil, err
}
return p, nil
}
// Call a remote target
//
// BLOCKING until either connected, pactor states disconnect or timeout occures
func (p *Modem) call(targetCall string) (err error) {
p.remoteAddr = targetCall
if err = p.connect(); err != nil {
return err
}
select {
case <-p.flags.connected:
writeDebug("Link setup successful", 1)
case <-p.flags.disconnected:
p.close()
return fmt.Errorf("Link setup failed")
case <-time.After(90 * time.Second):
p.close()
return fmt.Errorf("Link setup timed out")
}
return nil
}
// Send additional initialisation command stored in the InitScript
//
// Each command has to be on a new line
func (p *Modem) runInitScript(initScript string) error {
if _, err := os.Stat(initScript); os.IsNotExist(err) {
return fmt.Errorf("ERROR: PTC init script defined but not existent: %s", initScript)
}
file, err := os.Open(initScript)
if err != nil {
return err
}
defer file.Close()
scanner := bufio.NewScanner(file)
for scanner.Scan() {
if _, _, err = p.writeAndGetResponse(scanner.Text(), -1, false, 1024); err != nil {
return err
}
}
if err := scanner.Err(); err != nil {
return err
}
return nil
}
// Start all three controll threads: status thread, send thrad and read thread
//
// Wait 1 second to allow all thread to start working before sending
// data/commands or receiving form the internal buffers
func (p *Modem) runControlLoops() error {
p.wg.Add(3)
go p.statusThread()
go p.receiveThread()
go p.sendThread()
return nil
}
// Status thread: Monitoring the pactor status, handling changes in link state
//
// Is run twice the frequency of send/receive thread
func (p *Modem) statusThread() {
writeDebug("start status thread", 2)
for {
if p.flags.exit {
break
}
p.updatePactorState()
p.eventHandler()
time.Sleep(500 * time.Millisecond)
}
p.wg.Done()
writeDebug("exit status thread", 2)
}
// Receive thread: receiving data from modem if available
//
// Pactor modem status must be "connected". New data is written to the recv_buffer
// channel. BLOCKING until recvBuf has been read (e.g. by Read() function)
func (p *Modem) receiveThread() {
writeDebug("start receive thread", 2)
for {
if p.flags.exit {
close(p.recvBuf)
break
}
if p.state == Connected {
var res []byte
chunkSize := 10240
if channels, err := p.getChannelsWithOutput(); err == nil {
for _, c := range channels {
if c == PactorChannel {
_, data, _ := p.writeAndGetResponse("G", c, true, chunkSize)
if _, res, _ = p.checkResponse(data, c); res != nil {
p.recvBuf <- res
writeDebug("response: "+string(res)+"\n"+hex.Dump(res), 3)
}
break
}
}
}
}
time.Sleep(1000 * time.Millisecond)
}
p.wg.Done()
writeDebug("exit receive thread", 2)
}
// Send thread: Write data or command into the transmit buffer of the modem
//
// Commands are sent imediately where as payload (e.g. written by Write()) is
// held back until maximum number of frames not transmitted drops below
// MaxFrameNotTX
func (p *Modem) sendThread() {
writeDebug("start send thread", 2)
for {
if p.flags.exit {
break
}
select {
case cmd := <-p.cmdBuf:
writeDebug("Write ("+strconv.Itoa(len(cmd))+"): "+cmd, 2)
p.writeChannel(cmd, PactorChannel, true)
default:
}
if p.getNumFramesNotTransmitted() < MaxFrameNotTX {
data := p.getSendData()
if len(data) > 0 {
writeDebug("Write ("+strconv.Itoa(len(data))+"): "+hex.EncodeToString(data), 2)
p.writeChannel(string(data), PactorChannel, false)
}
}
time.Sleep(1000 * time.Millisecond)
}
p.wg.Done()
writeDebug("exit send thread", 2)
}
// Get data to be sent from the sendBuf channel.
//
// The amount of data bytes read from the sendBuf channel is limited by
// MaxSendData as the modem only accepts MaxSendData of bytes each command
func (p *Modem) getSendData() (data []byte) {
count := 0
for {
if count < MaxSendData {
select {
case b := <-p.sendBuf:
data = append(data, b)
count++
p.mux.bufLen.Lock()
p.sendBufLen--
p.mux.bufLen.Unlock()
default:
writeDebug("No more data to send after "+strconv.Itoa(count)+" bytes", 3)
return
}
} else {
writeDebug("Reached max send data size ("+strconv.Itoa(count)+" bytes)", 3)
return
}
}
}
// Wait for transmission to be finished
//
// BLOCKING until either all frames are tranmitted and acknowledged or timeouts
// occures
func (p *Modem) waitTransmissionFinish(t time.Duration) error {
timeout := time.After(t)
tick := time.Tick(500 * time.Millisecond)
for {
notAck := p.getNumFrameNotAck()
notTrans := p.getNumFramesNotTransmitted()
select {
case <-timeout:
if notAck != 0 && notTrans != 0 {
return errors.New("Timeout: " + strconv.Itoa(notAck) + "frames not ack and " + strconv.Itoa(notTrans) + " frames not transmitted")
} else if notAck != 0 {
return errors.New("Timeout: " + strconv.Itoa(notAck) + "frames not ack")
} else {
return errors.New("Timeout: " + strconv.Itoa(notTrans) + " frames not transmitted")
}
case <-tick:
if notAck == 0 && notTrans == 0 {
return nil
}
}
}
}
// Send connection request
func (p *Modem) connect() (err error) {
return p.send("C " + p.remoteAddr)
}
// Send disconnect request
//
// The modem tries to disconnect gracefully (e.g transmitting all remaining
// frames). Check with waitTransmissionFinish() for remaining or not acknowledged
// frames.
func (p *Modem) disconnect() (err error) {
return p.send("D")
}
// Force disconnect
//
// Try to disconnect with disconnect() first. Clears all data remaining in
// modem transmission buffer
func (p *Modem) forceDisconnect() (err error) {
return p.send("DD")
}
// Send command to the pactor modem
func (p *Modem) send(msg string) error {
p.cmdBuf <- msg
return nil
}
// Close current serial connection. Stop all threads and close all channels.
func (p *Modem) close() (err error) {
if p.flags.closed {
return nil
}
p.flags.closed = true
p.flags.exit = true
close(p.flags.closeWriting)
close(p.flags.disconnected)
close(p.flags.connected)
close(p.cmdBuf)
close(p.sendBuf)
writeDebug("waiting for all threads to exit", 2)
p.wg.Wait()
p.hostmodeQuit()
p.device.Close()
return nil
}
// Start modem hostemode (CRC Hostmode)
func (p *Modem) hostmodeStart() error {
writeDebug("start hostmode", 1)
_, _, err := p.writeAndGetResponse("JHOST4", -1, false, 1024)
_, _, err = p.read(1024)
return err
}
// Quit modem hostmode
func (p *Modem) hostmodeQuit() error {
//wait a bit for other commands to finish
time.Sleep(100 * time.Microsecond)
_, _, err := p.writeAndGetResponse("JHOST0", 0, true, 1024)
_, _, err = p.writeAndGetResponse("", -1, false, 1024)
return err
}
// Restart the pactor modem
func (p *Modem) restart() error {
_, _, err := p.writeAndGetResponse("RESTART", -1, false, 1024)
return err
}
// Update the pactor state
//
// Set the pactor state according to the state polled form modem
func (p *Modem) updatePactorState() (err error) {
p.channelState, err = p.getChannelsStatus(PactorChannel)
if err != nil {
writeDebug("Could not read Pactor state", 1)
return err
}
debugLevel := 3
switch p.channelState.f {
case 0:
writeDebug("Pactor: Disconnected", debugLevel)
p.state = Disconnected
case 1:
writeDebug("Pactor: Link Setup", debugLevel)
p.state = LinkSetup
case 2:
writeDebug("Pactor: Frame Reject", debugLevel)
p.state = Connected
case 3:
writeDebug("Pactor: Disconnect request", debugLevel)
p.state = DisconnectReq
case 4:
writeDebug("Pactor: Information transfer", debugLevel)
p.state = Connected
case 5:
writeDebug("Pactor: Reject frame sent", debugLevel)
p.state = Connected
case 6:
writeDebug("Pactor: Waiting acknowledgement", debugLevel)
p.state = Connected
default:
writeDebug("Pactor: Unkown state", 1)
}
return nil
}
// Handle changes in pactor state (events)
//
// Set/clear flags according to the event occured. Try to close connection
// gracefully if connection is lost or disconnect request has been received
func (p *Modem) eventHandler() {
if p.state != p.stateOld {
if p.state == Connected {
setFlag(p.flags.connected)
writeDebug("Connection established", 1)
}
if p.stateOld == LinkSetup && p.state == Disconnected {
setFlag(p.flags.disconnected)
writeDebug("Link setup failed", 1)
}
if p.stateOld == Connected && p.state == Disconnected ||
p.stateOld == DisconnectReq && p.state == Disconnected {
if p.flags.closeCalled != true {
p.flags.closeCalled = true
writeDebug("Connection lost", 1)
go p.close() //run as separate thread in order not to block
}
setFlag(p.flags.disconnected)
writeDebug("Disconnect occured", 1)
}
if p.stateOld == Connected && p.state == DisconnectReq {
go p.Close() //run as separate thread in order not to block
writeDebug("Disconnect requested", 1)
}
p.stateOld = p.state
}
}
// Set specified flag (channel)
func setFlag(flag chan struct{}) {
flag <- struct{}{}
}
// Get the number of Status Link messages not displayed (not read from modem)
func (p *Modem) getNumStatLinkMsgNotDispl() int {
return p.channelState.a
}
// Get number of frames received but not displayed (not read from modem)
func (p *Modem) getNumFramesRecvNotDispl() int {
return p.channelState.b
}
// Get number of frames not yet transmitted by the modem
func (p *Modem) getNumFramesNotTransmitted() int {
return p.channelState.c
}
// Get number of frames not acknowledged by the remote station
func (p *Modem) getNumFrameNotAck() int {
return p.channelState.d
}
// Check if serial device is still available (e.g still connected)
func (p *Modem) checkSerialDevice() (err error) {
if _, err := os.Stat(p.devicePath); os.IsNotExist(err) {
return fmt.Errorf("ERROR: Device %s does not exist", p.devicePath)
}
return nil
}
// Poll channel 255 with "G" command to find what channels have output.
// Write them into the channels list.
func (p *Modem) getChannelsWithOutput() (channels []int, err error) {
//Poll Channel 255 to find what channels have output
n, chs, err := p.writeAndGetResponse("G", 255, true, 1024)
if err != nil {
return nil, err
}
channels = make([]int, 0)
for i, ch := range []byte(chs)[:n-1] {
if (i == 0 && ch == 255) || (i == 1 && ch == 1) {
continue
}
channels = append(channels, int(ch)-1)
}
writeDebug("Channels with output: "+fmt.Sprintf("%#v", channels), 3)
return
}
// Query channel status ("L" command) of stated channel
//
// Returns struct of type cstate.
func (p *Modem) getChannelsStatus(ch int) (channelState cstate, err error) {
if ch == 0 {
return cstate{}, fmt.Errorf("L-command for channel 0 not implemented")
}
_, stat, err := p.writeAndGetResponse("L", ch, true, 1024)
if err != nil {
return cstate{}, err
}
if len(stat) < 3 {
return cstate{}, fmt.Errorf("No answer to the L-command")
}
writeDebug("Status string:\n"+hex.Dump([]byte(stat)), 3)
s := strings.Split(strings.Replace(stat[2:], "\x00", "", -1), " ")
if len(s) < 6 {
return cstate{}, fmt.Errorf("L-command response to short")
}
channelState.a, _ = strconv.Atoi(s[0])
channelState.b, _ = strconv.Atoi(s[1])
channelState.c, _ = strconv.Atoi(s[2])
channelState.d, _ = strconv.Atoi(s[3])
channelState.e, _ = strconv.Atoi(s[4])
channelState.f, _ = strconv.Atoi(s[5])
writeDebug(fmt.Sprintf("ChannelState: %+v", channelState), 2)
return channelState, nil
}
// Do some checks on the returned data.
//
// Currently, only connection information (payload) messages are passed on
func (p *Modem) checkResponse(resp string, ch int) (n int, data []byte, err error) {
if len(resp) < 3 {
return 0, nil, fmt.Errorf("No data")
}
head := []byte(resp[:3])
payload := []byte(resp[3:])
length := int(head[2]) + 1
pl := len(payload)
if int(head[0]) != ch {
writeDebug("WARNING: Returned data does not match polled channel\n"+hex.Dump([]byte(resp)), 1)
return 0, nil, fmt.Errorf("Channel missmatch")
}
if int(head[1]) != 7 {
writeDebug("Not a data response: "+string(payload), 1)
return 0, nil, fmt.Errorf("Not a data response")
}
if length != pl {
writeDebug("WARNING: Data length "+strconv.Itoa(pl)+" does not match stated amount "+strconv.Itoa(length)+". After "+strconv.Itoa(p.goodChunks)+" good chunks.", 1)
p.goodChunks = 0
if pl < length {
// TODO: search for propper go function
for i := 0; i < (length - pl); i++ {
payload = append(payload, 0x00)
}
} else {
payload = payload[:length]
}
} else {
p.goodChunks += 1
writeDebug("Good chunk", 2)
}
return length, payload, nil
}
// Write and read response from pactor modem
//
// Can be used in both, normal and hostmode. If used in hostmode, provide
// channel (>=0). If used in normal mode, set channel to -1, isCommand is
// ignored.
func (p *Modem) writeAndGetResponse(msg string, ch int, isCommand bool, chunkSize int) (int, string, error) {
var err error
p.mux.pactor.Lock()
defer p.mux.pactor.Unlock()
if ch >= 0 {
err = p._writeChannel(msg, ch, isCommand)
} else {
err = p._write(msg)
}
if err != nil {
return 0, "", err
}
// allow the message/command to be processed before reading the response
time.Sleep(200 * time.Millisecond)
var n int
var str string
i := 0
for {
n, str, err = p._read(chunkSize)
if err == nil {
break
}
i += 1
if i > 9 {
writeDebug("No successful read after 10 times!", 1)
return 0, "", err
}
}
writeDebug("response: "+str+"\n"+hex.Dump([]byte(str)), 2)
if ch >= 0 {
// check for re-request #170#170#170#85
for {
if str != fmt.Sprintf("%c%c%c%c", 170, 170, 170, 85) {
break
}
// packet was re-requested!!
writeDebug("Packet re-request received!", 2)
err = p._writeChannel(msg, ch, isCommand)
if err != nil {
return 0, "", err
}
time.Sleep(200 * time.Millisecond)
n, str, err = p._read(chunkSize)
}
// check then length to prevent out of range panics
// if the answer is <=2 bytes, it's not a CRC hostmode packet
if len(str) > 2 {
// CRC Hostmode decoding
// we "hexlify" it first, that makes it easier to debug
// then we rely on helper functions
hexstring := hex.EncodeToString([]byte(str))
// Step 1: destuff
hexstring = unstuff(hexstring)
// Step 2: check CRC
if checkcrc(hexstring) == false {
writeDebug("Wrong checksum in package!", 1)
return 0, "", errors.New("Checksum error at receiving packet")
}
//remove #170#170 at the beginning at chksum at the end
hexstring = hexstring[4 : len(hexstring)-4]
r, err := hex.DecodeString(hexstring)
if err != nil {
return 0, "", err
}
p.packetcounter = !(p.packetcounter)
str = string(r)
n = len(str)
} else {
//packet is too short to be a real WA8DED packet
return 0, "", errors.New("packet too short to be a WA8DED packet")
}
}
return n, str, err
}
// Write to serial connection (thread safe)
//
// No other read/write operation allowed during this time
func (p *Modem) write(cmd string) error {
p.mux.pactor.Lock()
defer p.mux.pactor.Unlock()
return p._write(cmd)
}
// Write to serial connection (NOT thread safe)
//
// If used, make shure to lock/unlock p.mux.pactor mutex!
func (p *Modem) _write(cmd string) error {
if err := p.checkSerialDevice(); err != nil {
writeDebug(err.Error(), 1)
return err
}
writeDebug("write: "+cmd, 2)
p.mux.device.Lock()
defer p.mux.device.Unlock()
if _, err := p.device.Write([]byte(cmd + "\r")); err != nil {
writeDebug(err.Error(), 2)
return err
}
time.Sleep(5 * time.Millisecond)
return nil
}
// Write channel to serial connection (thread safe)
//
// No other read/write operation allowed during this time
func (p *Modem) writeChannel(msg string, ch int, isCommand bool) error {
p.mux.pactor.Lock()
defer p.mux.pactor.Unlock()
return p._writeChannel(msg, ch, isCommand)
}
// *** Helper functions for the CRC hostmode
// Allthough these functions are small, I prefer to keep their functionality
// separate. They follow the steps in the SCS documentation
// helper function: de-hexlify and write to debug channel
func printhex(s string) {
t, _ := hex.DecodeString(s)
writeDebug(string(t), 3)
}
// helper function: "unstuff" a string
func unstuff(s string) string {
//Expect: the string contains aa aa at the beginning, that should NOT be
//stuffed
n, _ := hex.DecodeString(s[4:])
n = bytes.Replace(n, []byte{170, 0}, []byte{170}, -1)
var r []byte
r = append([]byte{0xaa, 0xaa}, n...)
re := hex.EncodeToString(r)
return re
}
// helper function: "stuff" a string: replaces every #170 with #170#0
func stuff(s string) string {
//Expect: the string contains aa aa at the beginning, that should NOT be
//stuffed
n, err := hex.DecodeString(s[4:])
if err != nil {
writeDebug("ERROR in Stuff: "+err.Error(), 1)
}
n = bytes.Replace(n, []byte{170}, []byte{170, 0}, -1)
var r []byte
r = append([]byte{0xaa, 0xaa}, n...)
re := hex.EncodeToString(r)
return re
}
// helper function: calculates the CCITT-CRC16 checksum
func checksum(s string) uint16 {
tochecksum, _ := hex.DecodeString(s[4:])
chksum := bits.ReverseBytes16(crc16.ChecksumCCITT([]byte(tochecksum)))
return chksum
}
// helper fuction: check the checksum by comparing
func checkcrc(s string) bool {
tochecksum, _ := hex.DecodeString(s[4 : len(s)-3])
chksum := bits.ReverseBytes16(crc16.ChecksumCCITT([]byte(tochecksum)))
pksum, _ := hex.DecodeString(s[len(s)-4:])
return (binary.BigEndian.Uint16(pksum) == chksum)
}
// super helper fuction: convert an ordinary WA8DED message into a CRC-Hostmode message
func docrc(msg string) string {
// step 1: add a #170170
msg = fmt.Sprintf("%02x%02x%s", 170, 170, msg)
// step 2: calculate and add the checksum
chksum := checksum(msg)
msg = fmt.Sprintf("%s%04x", msg, chksum)
// step 3: add "stuff" bytes
msg = stuff(msg)
return msg
}
// Write channel to serial connection (NOT thread safe)
//
// If used, make shure to lock/unlock p.mux.pactor mutex!
func (p *Modem) _writeChannel(msg string, ch int, isCommand bool) error {
if err := p.checkSerialDevice(); err != nil {
writeDebug(err.Error(), 1)
return err
}
var d string
switch {
case !p.packetcounter && !isCommand:
d = "00"
case !p.packetcounter && isCommand:
d = "01"
case p.packetcounter && !isCommand:
d = "80"
case p.packetcounter && isCommand:
d = "81"
}
c := fmt.Sprintf("%02x", ch)
l := fmt.Sprintf("%02x", (len(msg) - 1))
s := hex.EncodeToString([]byte(msg))
// add crc hostmode addons
bs, _ := hex.DecodeString(docrc(fmt.Sprintf("%s%s%s%s", c, d, l, s)))
writeDebug("write channel: \n"+hex.Dump(bs), 2)
p.mux.device.Lock()
defer p.mux.device.Unlock()
if _, err := p.device.Write(bs); err != nil {
writeDebug(err.Error(), 2)
return err
}
return nil
}
// Read from serial connection (thread safe)
//
// No other read/write operation allowed during this time
func (p *Modem) read(chunkSize int) (int, string, error) {
p.mux.pactor.Lock()
defer p.mux.pactor.Unlock()
return p._read(chunkSize)
}
// Read from serial connection (NOT thread safe)
//
// If used, make shure to lock/unlock p.mux.pactor mutex!
func (p *Modem) _read(chunkSize int) (int, string, error) {
if err := p.checkSerialDevice(); err != nil {
writeDebug(err.Error(), 1)
return 0, "", err
}
buf := make([]byte, chunkSize)
p.mux.device.Lock()
defer p.mux.device.Unlock()
n, err := p.device.Read(buf)
if err != nil {
writeDebug("Error received during read: "+err.Error(), 1)
return 0, "", err
}
return n, string(buf[0:n]), nil
}
|