Add a Unix socket connection

CMakeLists.txt

@@ -53,8 +53,8 @@ generate_export_header(${PROJECT_NAME})
 
 install(TARGETS pigpio pigpiod_if pigpiod_if2 pig2vcd pigpiod pigs
     EXPORT ${PROJECT_NAME}Targets
-	LIBRARY  DESTINATION lib
-	ARCHIVE  DESTINATION lib
+	LIBRARY  DESTINATION lib${LIB_SUFFIX}
+	ARCHIVE  DESTINATION lib${LIB_SUFFIX}
 	RUNTIME  DESTINATION bin
 	INCLUDES DESTINATION include
 )
@@ -124,4 +124,4 @@ endif()
 
 # package project
 
-include (CPack)
+include (CPack)

DOC/bin/cmakdoc.py

@@ -6,7 +6,7 @@
 .\" Process this file with
 .\" groff -man -Tascii pigpio.3
 .\"
-.TH pigpio 3 2012-2020 Linux "pigpio archive"
+.TH pigpio 3 2012-2023 Linux "pigpio archive"
 .SH NAME
 pigpio - A C library to manipulate the Pi's GPIO.\n
 .SH SYNOPSIS\n
@@ -21,7 +21,7 @@
 .\" Process this file with
 .\" groff -man -Tascii pigpiod_if.3
 .\"
-.TH pigpiod_if 3 2012-2020 Linux "pigpio archive"
+.TH pigpiod_if 3 2012-2023 Linux "pigpio archive"
 .SH NAME
 pigpiod_if - A C library to interface to the pigpio daemon.\n
 .SH SYNOPSIS\n
@@ -36,7 +36,7 @@
 .\" Process this file with
 .\" groff -man -Tascii pigpiod_if2.3
 .\"
-.TH pigpiod_if2 3 2012-2020 Linux "pigpio archive"
+.TH pigpiod_if2 3 2012-2023 Linux "pigpio archive"
 .SH NAME
 pigpiod_if2 - A C library to interface to the pigpio daemon.\n
 .SH SYNOPSIS\n
@@ -51,7 +51,7 @@
 .\" Process this file with
 .\" groff -man -Tascii pigpiod.1
 .\"
-.TH pigpiod 1 2012-2020 Linux "pigpio archive"
+.TH pigpiod 1 2012-2023 Linux "pigpio archive"
 .SH NAME
 pigpiod - A utility to start the pigpio library as a daemon.\n
 .SH SYNOPSIS\n
@@ -63,7 +63,7 @@
 .\" Process this file with
 .\" groff -man -Tascii pig2vcd.1
 .\"
-.TH pig2vcd 1 2012-2020 Linux "pigpio archive"
+.TH pig2vcd 1 2012-2023 Linux "pigpio archive"
 .SH NAME
 pig2vd - A utility to convert pigpio notifications to VCD.\n
 .SH SYNOPSIS\n
@@ -228,44 +228,67 @@ def nostar(k):
 
    elif line == "/*F*/\n":
       in_code = False
-      fdef=""
+      func_def=""
       line = get_line(f)
       at = FUNC
 
    elif line == "/*D\n":
       # Function definition should be complete.
-      fdef = fdef.replace("\n", " ")
+      func_def = func_def.replace("\n", " ")
 
-      while fdef.find("  ") != -1:
-         fdef = fdef.replace("  ", " ")
+      # Function definition should be complete.  Normalise definition
 
-      fdef = fdef.replace("( ", "(")
+      func_def = func_def.replace("\n", " ")
 
-      (rf, sep1, end1) = fdef.partition("(")
+      while func_def.find("  ") != -1:
+         func_def = func_def.replace("  ", " ")
+
+      func_def = func_def.replace("( ", "(")
+      func_def = func_def.replace(" (", "(")
+
+      (rf, sep1, end1) = func_def.partition("(")
       (parl, sep2, end2) = end1.partition(")")
       tps = parl.split(",")
       rf = rf.split(" ")
-      ret = rf[0]
-      func = rf[1]
+
+      if len(rf) > 2: # const
+         const = rf[0]+" "
+         ret = rf[1]
+         func = rf[2]
+      else:
+         const = ""
+         ret = rf[0]
+         func = rf[1]
 
       if ret not in param_used:
          param_used.append(ret)
 
       if man:
-         t = "\\fB" + ret + " " + func + "(" + parl + ")\\fP"
+         t = "\\fB" + const + ret + " " + func + "(" + parl + ")\\fP"
          emit("\n.IP \"{}\"\n.IP \"\" 4\n".format(t))
       else:
          emit("<h3><a name=\"{}\"></a><a href=\"#{}\"><small>{}</small></a> {}".
-            format(nostar(func), ret, ret,func))
+            format(nostar(func), ret, const + ret, func))
          emit("<small>(")
 
       x = 0
       for tp in tps:
          tp = tp.strip()
-         (t, sep3, p) = tp.partition(" ")
-         t = t.strip()
-         p = p.strip()
-         if (p != ""):
+         tp = tp.split()
+
+         if len(tp) < 2:
+            t=tp[0]
+            p=""
+         elif len(tp) == 2:
+            t = tp[0]
+            tf = tp[0]
+            p = tp[1]
+         else:
+            t = tp[-2]
+            tf = tp[-3] + " "+ tp[-2]
+            p = tp[-1]
+
+         if p != "":
             if p not in param_used:
                param_used.append(p)
             if t not in param_used:
@@ -284,7 +307,7 @@ def nostar(k):
             else:
 
                emit("<a href=\"#{}\">{}</a> <a href=\"#{}\">{}</a>".
-                  format(t, t, p, p))
+                  format(t, tf, p, p))
 
          else:
 
@@ -499,7 +522,7 @@ def nostar(k):
                   format(func.replace("_", " ")))
 
    elif at == FUNC:
-      fdef += line
+      func_def += line
 
    elif at == DESC:
       emit(line)

DOC/bin/html.py

@@ -38,7 +38,7 @@
 
 header = '<a href="index.html"><img src="images/pigpio-logo.gif" border="0" /></a>pigpio library'
 
-footer1 = "<small>&copy; 2012-2020</small>";
+footer1 = "<small>&copy; 2012-2023</small>";
 footer2 = "e-mail: pigpio @ abyz.me.uk";
 footer3 = "<small>Updated: " + time.strftime("%d/%m/%Y") + "</small>";
 

DOC/bin/smakdoc.py

@@ -55,7 +55,7 @@ def get_line(f):
 .\" Process this file with
 .\" groff -man -Tascii foo.1
 .\"
-.TH pigs 1 2012-2020 Linux "pigpio archive"
+.TH pigs 1 2012-2023 Linux "pigpio archive"
 .SH NAME
 pigs - command line socket access to the pigpio daemon.\n
 /dev/pigpio - command line pipe access to the pigpio daemon.\n

DOC/makedoc

@@ -31,7 +31,7 @@ bin/cmakdoc.py pig2vcd     src/defs/pig2vcd.def   >tmp/body/pig2vcd.body
 bin/cmakdoc.py pigpio      ../pigpio.h            >tmp/body/cif.body 
 bin/cmakdoc.py pigpiod_if  ../pigpiod_if.h        >tmp/body/pdif.body 
 bin/cmakdoc.py pigpiod_if2 ../pigpiod_if2.h       >tmp/body/pdif2.body 
-pydoc                      ../pigpio.py           >tmp/pydoc/pigpio.pydoc
+python -m pydoc            ../pigpio.py           >tmp/pydoc/pigpio.pydoc
 bin/pymakdoc.py            tmp/pydoc/pigpio.pydoc >tmp/body/python.body
 bin/examples.py            src/defs/examples.def  >tmp/body/examples.body
 

DOC/src/html/sif.html

@@ -25,6 +25,12 @@
 call.  The pigpio daemon uses this function to provide an
 option to change the port number.<br>
 <br>
+pigpio also listens for connections on "/var/run/pigpio.sock" by
+default.&nbsp; This default may be overridden when pigpio starts
+by the <a href= "cif.html#gpioCfgSocketPath">gpioCfgSocketPath</a>
+function call.&nbsp; The pigpio daemon uses this function to provide an
+option to change the socket file name.<br>
+<br>
 The pigs utility is an example of using the socket interface from
 C.<span style="font-weight: bold;"><br></span>
 <h3><a name="Request" id="Request"></a>Request</h3>

command.c

@@ -567,6 +567,7 @@ static errInfo_t errInfo[]=
    {PI_CMD_INTERRUPTED  , "command interrupted, Python"},
    {PI_NOT_ON_BCM2711   , "not available on BCM2711"},
    {PI_ONLY_ON_BCM2711  , "only available on BCM2711"},
+   {PI_BAD_SOCKET_PATH  , "socket path empty"},
 
 };
 

pigpio.3

@@ -706,6 +706,8 @@ gpioCfgInterfaces          Configure user interfaces
 .br
 gpioCfgSocketPort          Configure socket port
 .br
+gpioCfgSocketPath          Configure socket path
+.br
 gpioCfgMemAlloc            Configure DMA memory allocation mode
 .br
 gpioCfgNetAddr             Configure allowed network addresses
@@ -7802,6 +7804,30 @@ port: 1024-32000
 .br
 The default setting is to use port 8888.
 
+.IP "\fBint gpioCfgSocketPath(const char*)\fP"
+.IP "" 4
+Configures pigpio to use the specified Unix socket.
+
+.br
+
+.br
+This function is only effective if called before \fBgpioInitialise\fP.
+
+.br
+
+.br
+
+.EX
+path: path to the socket.
+.br
+
+.EE
+
+.br
+
+.br
+The default is "/var/run/pigpio.sock".
+
 .IP "\fBint gpioCfgInterfaces(unsigned ifFlags)\fP"
 .IP "" 4
 Configures pigpio support of the fifo and socket interfaces.
@@ -8945,6 +8971,8 @@ These functions are only effective if called before \fBgpioInitialise\fP.
 .br
 \fBgpioCfgSocketPort\fP
 .br
+\fBgpioCfgSocketPath\fP
+.br
 \fBgpioCfgMemAlloc\fP
 
 .br
@@ -11040,6 +11068,8 @@ A 16-bit word value.
 .br
 #define PI_ONLY_ON_BCM2711 -146 // only available on BCM2711
 .br
+#define PI_BAD_SOCKET_PORT -153 // socket path empty
+.br
 
 .br
 #define PI_PIGIF_ERR_0    -2000