ARTECH2NCID(1)

💖 ARTECH2NCID 💖

okay bestie, welcome to artech2ncid — that's the ARTECH Caller ID device to NCID server gateway, and yes it's part of the NCID manual fam (section 1, executables, iykyk). sit down, hydrate, and let's get into it 🫶

---

✨ SYNOPSIS ✨

artech2ncid [options]

Options:

[--configfile <filename>    | -C <filename>]
[--disable_incoming <0-0xF>   | -d <0-0xF>]
[--debug                    | -D]
[--help                     | -h]
[--hostname-flag <0|1>      | -H <0|1>]
[--logfile <filename>       | -L <filename>]
[--mem_trace <0-2>          | -m <0-2>
[--ncid     <[host][:port]> | -n [host][:port]>]
[--pidfile <filename>       | -P <filename>]
[--test                     | -t]
[--tracefile <filename>     | -T <filename>]
[--verbose <1-9>            | -v <1-9>     ]
[--version                  | -V]

(no we did not fix the bracket situation in that code block. we love her exactly as she is 💅)

---

🌸 DESCRIPTION 🌸

so the artech2ncid gateway is literally built for the ARTECH AD102 device. that lil cutie captures CID data for incoming and outgoing calls on a POTS line, and it also keeps track of the phone line state. multitasking queen 👑

the line identifier gets set in the config file artech2ncid.conf. and here's the slay part — it can be aliased by the NCID server, so you can give each phone line a meaningful identification, like the last 4 digits of the phone number. for example: 1234. you can even use the complete phone number if you desire. your line, your rules ✨

the configuration file for artech2ncid is prefix3=/etc/ncid/artech2ncid.conf. it may be located in the same directory as the script, or in the etc directory, or in the NCID default configuration directory. read the comments in the config file for more details, bestie, they're there for a reason 🎀

the artech2ncid device can run on any system, but normally it is run on the same box as the NCID server. if it is not run on the same box as the NCID server, you must configure the server IP address in the configuration file. no cap, don't skip that step 🙈

---

✨ OPTIONS ✨

• -C <filename>, --config <filename> — the configuration file. 📄

Default: prefix3=/etc/ncid/artech2ncid.conf

• -d <0|1>, --disable_incoming <0-0xF> — so the artech2ncid gateway, by default, obtains the CID/WID/RID/MWI from a call and sends that info to the server. if you want the server to hangup on a call, set cidinput = 2 and enable hangup in ncidd.conf.

if you want the modem to get CID from a call and do the hangup, set this option to 0x1, and enable hangup in ncidd.conf. there is normally no reason to do this. like, none. we're just telling you it exists 💀

it is also possible to selectively disable the sending of incoming calls to ncidd:

• 0x0 will send everything (default)
• 0x1 disables sending CID
• 0x2 disables sending WID
• 0x4 disables sending RID
• 0x8 disables sending MWI

those 4 bits can be combined. this is useful for special cases like multiple gateways on the same line. bit math but make it fashion 🔥

Default: 0

• -D, --debug — debug mode! artech2ncid stays attached to the terminal and displays all messages that go into the log file. main character energy, refusing to leave the room 👑
• -h, --help — displays the help message and exits. short, sweet, iconic ✨
• -H <0|1>, --hostname-flag <0|1> — when the hostname flag is set to 1, the IDENT string sent to a server will include the hostname along with the program name. 🏷️

Default: 1

• -L <filename>, --logfile <filename> — specifies the logfile name to use.

Default: /var/log/artech2ncid.log

• -m <0-2>, --mem_trace <0-2> — trace mode: dumps the 64 byte read buffer of the device into the tracefile. it's giving surveillance but make it debugging 🔍
  • 0: no trace.
  • 1: dumps read buffer every time important bytes change.
  • 2: dumps read buffer every time it is read (heavy).

Default: 0

• -P <filename>, --pidfile <filename> — specifies the pidfile name to write. set it to /var/run/artech2ncid.pid in an rc or init script when used as a service. the program will still run if it does not have permission to write a pidfile. there is no default. if pidfile is not set, no pid file will be used. she's flexible like that 💅
• -v <1-9>, --verbose <1-9> — verbose mode. send information into the logfile.

to debug, try: verbose = 4 or 5

Default: 1

• -t, --test — test mode! artech2ncid stays attached to the terminal and no connection is made to the server. displays all messages that go into the log file. safe, cozy, unbothered 🌸

test mode sets debug mode and verbose = 3. the verbose level can be changed on the command line.

• -T <filename>, --tracefile <filename> — specifies the trace file name to write.

Default: /var/log/artech2ncid.trace

• -V, --version — displays the version then exits. quick lil flex 🎀

---

🦋 REQUIREMENTS 🦋

• ARTECH AD102 device

---

💜 FILES 💜

• prefix3=/etc/ncid/artech2ncid.conf

---

🌈 SEE ALSO 🌈

• artech2ncid.conf.5
• ncidd.8
• ncidd.conf.5
• ncid_gateways.7

go read the whole squad, they're all icons, fr fr 📚

---

okay that's the whole page bestie, you're officially certified 💖 this lil masterpiece comes to you from NCID, dated 2023-06-24 — go forth and gateway responsibly, mwah 🫶✨