Merge pull request #255 from currentc57/master

nextion_ez pushCmdArg() more general and fixed nextion baud

Author: PropGit

libraries/community/p1/All/nextion_ez/demo/nextion_ez_demo.HMI

@@ -1,6 +1,6 @@
 '' =================================================================================================
 ''
-''   File....... nextion_ez_p1.spin
+''   File....... nextion_ez_demo.spin
 ''   Purpose....
 ''   Author..... Charles Current
 
@@ -127,7 +127,7 @@ PRI trigger00
 
 PRI trigger01
   nextion.pushCmdArg(0)                               ' or up to 16 arguments can pe passed via a stack
-  nextion.sendCmd(STRING("page"))                       ' this allows the easy use of variables and constants
+  nextion.sendCmd(STRING("page "))                       ' this allows the easy use of variables and constants
 
 PRI runCount
   run_count := NOT run_count

libraries/community/p1/All/nextion_ez/demo/nextion_ez_demo.spin

@@ -49,11 +49,11 @@
            methods getCurrentPage(), getLastPage(), setCurrentPage() and setLastPage()
 
 }}
-
+'------------------------------------------------------------------------------
 CON
   SERIAL_MODE = %0000
-  ERROR_NUM = 777777
-
+  ERROR_NUM   = 777777
+'------------------------------------------------------------------------------
 VAR
   long  current_page_id
   long  last_current_page_id
@@ -63,23 +63,23 @@ VAR
   long  cmd_fifo[16]
   byte  cmd_fifo_head
   byte  cmd_fifo_tail
-
+'------------------------------------------------------------------------------
 OBJ
   _nextion      : "FullDuplexSerialAvail"               'a special version of FullDuplexSerial that provides an available method like Arduino and FullDuplexSerial
-
+'------------------------------------------------------------------------------
 PUB start(rxPin, txPin, baud)                        'Must be run before using object
 {{
   Must be run before using object
   Will start a new serial object in it's own cog using the pins and rate provided
 }}
   _nextion.start(rxPin, txPin, SERIAL_MODE, baud)
   waitcnt(clkfreq / 100 + cnt)                          'wait for serial to init
-
+'------------------------------------------------------------------------------
 PUB writeNum(ptr_component, num)                          'send a numeric value to nextion
 {{
   send a numeric value to nextion
   ptr_component should be a pointer to a string that names the object and attribute to receive the new value
-  _num is the value to assign to the object.attribute
+  num is the value to assign to the object.attribute
 
   example: nextion.writeNum(STRING("j0.val"), number)
 }}
@@ -89,7 +89,7 @@ PUB writeNum(ptr_component, num)                          'send a numeric value
   repeat 3
     _nextion.tx($FF)
 
-
+'------------------------------------------------------------------------------
 PUB writeStr(ptr_component, ptr_txt)                      'send a string value to nextion
 {{
   send a string value to nextion
@@ -105,7 +105,7 @@ PUB writeStr(ptr_component, ptr_txt)                      'send a string value t
   _nextion.tx($22)'double quote
   repeat 3
     _nextion.tx($FF)
-
+'------------------------------------------------------------------------------
 PUB writeByte(val)                                        'send raw data byte (not ASCII formated) to Nextion
 {{
   Main purpose and usage is for sending the raw data required by the addt command
@@ -114,23 +114,27 @@ PUB writeByte(val)                                        'send raw data byte (n
   example: nextion.writeByte(0)
  }}
   _nextion.tx(val)
-
+'------------------------------------------------------------------------------
 PUB pushCmdArg(argument)                                'load the argument FIFO with numeric arguments that are to be sent with the command using sendCmd()
 {{
-  Used to load the argument FIFO with numeric arguments that are to be sent with the command using sendCmd()
+  Used to load the argument FIFO with numeric arguments that are to be sent with the command using sendCmd().
+  This allows easier creation of methods that take a variable argument.
+  if using FIFO, the command string must include any required spaces or commas before the first FIFO argument
+
   example:  to send the command "page 1" to the nextion
             nextion.pushCmdArg(1)
-            nextion.sendCmd(STRING("page"))
+            nextion.sendCmd(STRING("page "))
 }}
   cmd_fifo[cmd_fifo_head] := argument
   cmd_fifo_head++
   if cmd_fifo_head > 15
     cmd_fifo_head := 0
-
+'------------------------------------------------------------------------------
 PUB sendCmd(ptr_command) | count, x, argument                               'send a command to nextion
 {{
-  send a command to nextion
+  Send a single string command to nextion.
   ptr_command should be a pointer to a string containing the command to be sent
+  if using FIFO, the command string must include any required spaces or commas before the first FIFO argument
 
   example: nextion.sendCmd(STRING("page 0"))
 }}
@@ -142,7 +146,6 @@ PUB sendCmd(ptr_command) | count, x, argument                               'sen
   _nextion.str(ptr_command)
 
   if(count > 0)
-    _nextion.tx(" ")
     x := 0
     repeat count
       if x > 0
@@ -156,7 +159,7 @@ PUB sendCmd(ptr_command) | count, x, argument                               'sen
   repeat 3
     _nextion.tx($FF)
 
-
+'------------------------------------------------------------------------------
 PUB addWave(id, channel, val)                           'Add single value to a Nextion waveform channel
 {{
   Add single value to a Nextion waveform channel
@@ -175,7 +178,7 @@ PUB addWave(id, channel, val)                           'Add single value to a N
   repeat 3
     _nextion.tx($FF)
 
-
+'------------------------------------------------------------------------------
 PUB readStr(ptr_component, ptr_return) : status | _char, _pos, _time, _ms, _ffCount, _end  'Read a string value from nextion, will return a 1 if successful or -1 on error
 {{
   Read a string value from nextion, will return a 1 if successful or -1 on error
@@ -241,7 +244,7 @@ PUB readStr(ptr_component, ptr_return) : status | _char, _pos, _time, _ms, _ffCo
       return
 
   return 1
-
+'------------------------------------------------------------------------------
 PUB readNum(ptr_component) : num | _time, _ms, _ffCount, _end, _char, _count, _numBuff[4]   'read a numeric value from nextion, returns number value or 777777 on error
 {{
   Read a numeric value from nextion, returns number value or 777777 on error
@@ -314,10 +317,28 @@ PUB readNum(ptr_component) : num | _time, _ms, _ffCount, _end, _char, _count, _n
 
   return
 
-PUB readByte : _char                                    'read a byte from serial buffer (for use in custom commannds)
+PUB readByte : _char                                    'read a byte from serial buffer
+{{
+  Read a single byte from the serial buffer.
+
+  This is used to retrieve additional commmand bytes for parsing.  The first command byte is pulled from the buffer by listen() and is then
+  available via getCmd() method.  Any additional command bytes can be pulled from the buffer via readByte().
+
+  example:
+  PUB main()
+    nextion.listen                          ' need to run this to check for incoming data from the Nextion
+    if nextion.cmdAvail() > 0               ' has the nextion sent a command?
+      callCommand(nextion.getCmd())         ' get the 1st command byte and see parse it
+
+  PRI callCommand(_cmd)                       ' parse the 1st command byte and decide how to proceed
+    case _cmd
+      "T" :                                   ' standard Easy Nextion Library commands start with "T"
+        callTrigger(readByte())               ' so we need the second byte to know what function to call
+                                              ' custom commands can be added by expanding this case statement
+}}
   _char := _nextion.rxTime(100)                         'if timeout (-1) return error (-1)
   return
-
+'------------------------------------------------------------------------------
 PUB listen | _char, _time, _ms, _len, _cmdFound, _cmd      'check for incoming serial data from nextion, must be run frequently to respond to events
 {{
   Check for incoming serial data from nextion, must be run frequently to respond to events
@@ -374,31 +395,76 @@ PUB listen | _char, _time, _ms, _len, _cmdFound, _cmd      'check for incoming s
           cmd_avail := true
           cmd := _cmd
   return
-
+'------------------------------------------------------------------------------
 PUB getCurrentPage : _page                              'returns the current page id
-  return current_page_id
+{{
+  This method is provided as a way to read the methods current_page_id variable.
 
+  In order for the object to update the Id of the current page, you must write in the Preinitialize Event of every page: printh 23 02 50 XX ,
+  where XX the id of the page in HEX. Your code can then read the current page and previous page using the getCurrentPage() and getLastPage() methods.
+}}
+  return current_page_id
+'------------------------------------------------------------------------------
 PUB setCurrentPage(_page)                               'sets the current page id
-  current_page_id := _page
+{{
+  This method is provided as a way to write the methods current_page_id variable.
 
+  In some cases it is usefull to be able to change the methods current_page_id and/or last_current_page_id variables.
+}}
+  current_page_id := _page
+'------------------------------------------------------------------------------
 PUB getLastPage : _page                                 'returns the previous page id
-  return last_current_page_id
+{{
+  This method is provided as a way to read the methods last_current_page_id variable.
 
+  In order for the object to update the Id of the current page, you must write in the Preinitialize Event of every page: printh 23 02 50 XX ,
+  where XX the id of the page in HEX. Your code can then read the current page and previous page using the getCurrentPage() and getLastPage() methods.
+}}
+  return last_current_page_id
+'------------------------------------------------------------------------------
 PUB setLastPage(_page)                                  'sets the previous page id
-  last_current_page_id := _page
+{{
+  This method is provided as a way to write the methods last_current_page_id variable.
 
+  In some cases it is usefull to be able to change the methods current_page_id and/or last_current_page_id variables.
+}}
+  last_current_page_id := _page
+'------------------------------------------------------------------------------
 PUB cmdAvail : _avail                                   'returns true if commands in the buffer
+{{
+  After calling the listen() method, this method is used to see if there is a pending command from the Nextion.
+
+  example:
+  PUB main()
+    nextion.listen                          ' need to run this to check for incoming data from the Nextion
+    if nextion.cmdAvail() > 0               ' has the nextion sent a command?
+      callCommand(nextion.getCmd())         ' get the 1st command byte and see parse it
+}}
   _avail := cmd_avail
   cmd_avail := false
   return
-
+'------------------------------------------------------------------------------
 PUB getCmd : _cmd                                       'returns the 1st command byte
+{{
+  After calling the listen() method, and verifying that a command is available,
+  this method is used to see retrieve the 1st command byte.
+
+  example:
+  PUB main()
+    nextion.listen                          ' need to run this to check for incoming data from the Nextion
+    if nextion.cmdAvail() > 0               ' has the nextion sent a command?
+      callCommand(nextion.getCmd())         ' get the 1st command byte and see parse it
+}}
   return cmd
-
+'------------------------------------------------------------------------------
 PUB getCmdLen : _len                                  'returns the number of command bytes (for use in custom commands)
+{{
+  This method will return the number of bytes in the command buffer.
+  This could be useful for creating custom commands of variable length.
+}}
   return cmd_len
-
-con { license }
+'------------------------------------------------------------------------------
+CON { license }
 
 {{
 

libraries/community/p1/All/nextion_ez/nextion_ez.spin

@@ -1,6 +1,6 @@
 '' =================================================================================================
 ''
-''   File....... nextion_ez_p2.spin2
+''   File....... nextion_ez_demo.spin2
 ''   Purpose....
 ''   Author..... Charles Current
 
@@ -122,7 +122,7 @@ PRI trigger00()
 
 PRI trigger01()
   nextion.pushCmdArg(0)                               ' or up to 16 arguments can pe passed via a stack
-  nextion.sendCmd(STRING("page"))                       ' this allows the easy use of variables and constants
+  nextion.sendCmd(STRING("page "))                       ' this allows the easy use of variables and constants
 
 PRI runCount()
   run_count := NOT run_count