killerjulian / serialport-gsm-typescript

Library for the communication with GSM modems like sending and receiving SMS messages

Node SerialPort-GSM

SerialPort-GSM - A library for the communication with GSM modems like sending and receiving SMS messages.

Install

npm i serialport-gsm

Usage

Usage in JavaScript/TypeScript (with ES Modules):

import { Modem, SerialPortCommunicator } from 'serialport-gsm';

// Initialize a SerialPortCommunicator. For more options take a look at the full documentaion
const serialPortCommunicator = new SerialPortCommunicator('COM4');

// Initalization of the modem. For more options take a look at the full documentaion
const myModem = new Modem(serialPortCommunicator);

// You can listen to different events
myModem.on('onWriteToModem', (data) => console.log('>:', data.replace(/\n|\r/g, '')));
myModem.on('onDataReceived', (data) => console.log('<:', data.replace(/\n|\r/g, '')));

// Do whatever you want
async function start() {
  await myModem.open();

  console.log('.checkModem()', await myModem.checkModem());
  console.log('.getSignalInfo()', await myModem.getSignalInfo());
  console.log('.getRegisteredNetwork()', await myModem.getRegisteredNetwork());
  console.log('.getAvailableNetworks()', await myModem.getAvailableNetworks());
  console.log('.checkSimMemory()', await myModem.checkSimMemory());
  console.log('.getProductSerialNumber()', await myModem.getProductSerialNumber());
  console.log('.getOwnNumber()', await myModem.getOwnNumber());
  console.log('.getSimInbox()', await myModem.getSimInbox());
  console.log('.sendSms()', await myModem.sendSms('+XXXXXXXXX', 'Hello, Zap here!'));

  await myModem.close();
}

start();

You can find more information in the full documentation.

---

❤️ Contributors

Our thanks go to these wonderful people who have contributed to this project:

Made with contrib.rocks.

🤝 Contributing

Contributions, issues and feature requests are welcome! Feel you free to check issues page or create a pull request. We are happy about collaboration on this project.