1-Wire Automation Server v1.0.0
Contents
1. Adapter Attribute Enumerate V ADAPTER un ATTR ENUM OUT gt mom off User Manual Part 2 21 1 Wire Automation Server v1 0 0 Adapter Attribute Name ADAPTER fom 2 av Adapter Attribute Reconnect Y ADAPTER ae ATTR RECONN Sum interval OUT Adapter Disable V ADAPTER UN DISABLE cun 22 User Manual Part 2 1 Wire Automation Server v1 0 0 Adapter Enable Y ADAPTER aE ENABLE DEN Adapter Remove V ADAPTER dh REMOVE ouy User Manual Part 2 23 1 Wire Automation Server v1 0 0 Attribute cancel This command sets attributes of the client connection Label tscale select the temperature scale that is applied when the server formats temperature values in sensor data strings and short responses The default is Celsius Label cancel influences behavior when the client connection is closed If set to on the server cancels all queued commands that belong to the client If set to off all queued commands are detached from the client The default is off Authorize AUTH OUT username password 24 User Manual Part 2 1 Wire Automation Server v1 0 0 Block Cancel User Manu2. MASK 7 off PIO MASK User Manual Part 2 33 1 Wire Automation Server v1 0 0 Device Remove Y IN DEV REMOVE OUT This command remove the 1 Wire slave with the given ROM code If a non zero delay is present the server will wait for this number of milliseconds before removing the 1 Wire slave 34 User Manual Part 2 1 Wire Automation Server v1 0 0 Device RGB Controller COLOR MASK OUT IN DEV RGBCTRL OUT COLOR MASK Di COLOR MASK COLOR MASK i User Manual Part 2 35 1 Wire Automation Server v1 0 0 Device Sense IN DEV SENSE OUT IN OUT p RSP ID Device Sensed mfo sso ROM code 36 User Manual Part 2 1 Wire Automation Server v1 0 0 Device Switch DG Clear IN Y DEV SWITCH OUT n IN DG CLEAR OUT DEC OUT Clear a device group All 1 Wire slaves in the device group are removed thus become unknown to the server DG Move DG MOVE OUT 7 Device Move a device group to another location in the topology User Manual Part 2 37 1 Wire Automation Server v1 0 0 Done This response is generated when
3. IN UCH PURGE OUT Client command UCH Purge removes all empty unallocated channels Empty unallocated channels usually pile up when 1 Wire adapter appears and disappears regularly while it is set to enumerate automatically upon arrival The enumeration typically finds all 1 Wire slaves that are stored in one or more unallocated channels and moves these slaves behind the adapter s channel or channels resulting in empty unallocated channels The idea is to execute the UCH Purge command periodically in such case User Manual Part 2 51 1 Wire Automation Server v1 0 0 UCH Remove Y IN UCH REMOVE OUT Remove an unallocated channel If 1 Wire slaves reside in the unallocated channel the server moves them to the non present devices first Untie Y IN UNTIE OUT Untie all 1 Wire slaves residing behind a channel and move them to a new unallocated channel This macro command is expanded at the channel level 52 User Manual Part 2 1 Wire Automation Server v1 0 0 Version Y IN VERSION OUT aw gt version our gt version version This command responds with version information Currently the program version of the server is returned as a major minor micro triplet Wait User Manual Part 2 WAIT OUT 53 1 Wire Aut
4. command with identifier has completed 38 User Manual Part 2 1 Wire Automation Server v1 0 0 Dump Enumerate W IN DUMP OUT am topo OUT Enumerate 1 Wire slaves residing behind a channel This macro command is expanded at the channel level User Manual Part 2 39 1 Wire Automation Server v1 0 0 FF32 Y FF34 Y FF VA IN FF OUT Ha 40 User Manual Part 2 1 Wire Automation Server v1 0 0 Hardware 7 IN HW OUT gt HW REMOVE V HW ENABLE HW DISABLE 7 DETECT 7 ENUM UNTIE PROBE OUT User Manual Part 2 41 1 Wire Automation Server v1 0 0 Hardware Attribute Set hardware attributes Hardware Attribute Detect HW ATTR EN DETECT cun OUT Turn on or off automatic detection for all adapters Hardware Attribute Enumerate HW ATTR IN ENUM OUT Turn on or off automatic enumeration for all adapters 42 User Manual Part 2 1 Wire Automation Server v1 0 0 Hardware Disable HW DISABLE DM Enable all adapters This is a macro command Ha
5. Manual Part 2 1 Wire Automation Server v1 0 0 Short Response Identifier V SHORT IN OUT sensorid minute second va piosensed tccold vd pioset tcfault vi i rstz cntra d d j OUT User Manual Part 2 15 1 Wire Automation Server v1 0 0 Device Group 16 OUT User Manual Part 2 1 Wire Automation Server v1 0 0 6 Commands and Responses Adapter ADAPTER OUT W Adapter ID ENABLE V ADAPTER DISABLE V ADAPTER 7 ENUM UNTIE PROBE V ADAPTER REMOVE bans Base command for performing adapter related tasks User Manual Part 2 17 1 Wire Automation Server v1 0 0 Adapter Add Hom Fast V ADAPTER serial path ADD SERIAL ADAPTER ADD I2C bscdetect This client command adds a 1 Wire adapter The arguments following the add label describe one or more device nodes that make up a 1 Wire adapter If an adapter name is specified it must not match any existing adapter name If no adapter name is specified the server generates a unique adapter name The server always generates a unique name for dynamically added adapters like the DS9490 The Adapter Add client command is one of a handful of commands
6. that is executed immediately instead of being queued 18 User Manual Part 2 1 Wire Automation Server v1 0 0 Adapter Add I2C ADAPTER in ADD I2C SLR ds2482 mnu3 This syntax describes or more I2C slaves that reside on the same I2C bus and make up single adapter Any combination is allowed as long as no I2C slave addresses overlap with already defined I2C slaves on the same I2C bus Each I2C slave is reflected by device node The ds2482 label is used for DS2482 100 and DS2482 800 controllers The server distinguishes between these controllers when the built in 052482 driver is enabling the chip slave ad The abiowire label covers AbioWire and AbioWire adapters These adapters are software compatible The label results in the addition of three device nodes Labels mnu mnuO mnu1 mnu2 and mnu3 target m nu 1 Wire adapters User Manual Part 2 19 1 Wire Automation Server v1 0 0 Adapter Add Serial Y ADAPTER EN ADD SERIAL SCH This syntax describes 1 Wire master with serial interface 20 User Manual Part 2 1 Wire Automation Server v1 0 0 Adapter Attribute 7 ADAPTER V ADAPTER ATTR RECONN ADAPTER ATTR ENUM ADAPTER ATTR DETECT V ADAPTER ATTR NAME Adapter Attribute Detect V ADAPTER Ji ATTR DETECT OUT gt
7. 1 Wire Automation Server v1 0 0 User Manual Part 2 March 2015 1 Wire Automation Server v1 0 0 Table of Contents 1 Overview 2 Protocol Data UTF 8 Decoder Tokenizer Label Token Number Token String Token Comment Token Character Token Parser 3 Syntax Flow Diagrams 4 Command and Response Line Command Text Line Command Response Text Line Response 5 Common Syntax ROM Code Adapter Identifier Adapter Controller Adapter Controller Channel Port Identifier Sensor Identifier Short Response Identifier Device Group 6 Commande and Responses Adapter Adapter Add Adapter Add I2C Adapter Add Serial Adapter Attribute Adapter Attribute Detect Adapter Attribute Enumerate Adapter Attribute Name Adapter Attribute Reconnect Adapter Disable Adapter Enable 5 NN OO Ui Ul 9 9 10 11 11 12 12 12 13 13 14 14 15 16 17 17 18 19 20 21 21 21 22 22 22 23 User Manual Part 2 1 Wire Automation Server v1 0 0 Adapter Remove 23 Attribute 24 Authorize 24 Block 25 Cancel 25 Channel 26 Close 26 Controller 27 Detect 27 Device 28 Device Add 29 Device Attribute 29 Device Attribute Description 30 Device Attribute Force Ports 30 Device Attribute Power Mode 30 Device Attribute Poll 31 Device Locate 21 Device Located 31 Device Move 32 Device PIO 33 Device Remove 34 Device RGB Controller 35 Device Sense 36 Device Sensed 36 Device Switch 37 DG Clear 37 DG Move 37 Don
8. al Part 2 BLOCK OUT IN CANCEL OUT 25 1 Wire Automation Server v1 0 0 Channel OUT gt 7 DG MOVE CLEAR DETECT ENUM UNTIE dr Base command for performing tasks on the specified channel Close Y IN CLOSE OUT When the server executes this command it closes the connection with the client 26 User Manual Part 2 1 Wire Automation Server v1 0 0 Controller 7 DETECT 4 ENUM UNTIE PROBE Detect Y IN DETECT OUT Run the detection procedure for a controller optionally confined to a single channel This macro command is expanded at the controller level User Manual Part 2 27 1 Wire Automation Server v1 0 0 Device ROM code 7 DEV ADD OUT DEV MOVE DEV SENSE DEV DEV RGBCTRL DEV SWITCH DEV ATTR 7 DEV LOCATE Base command for performing tasks on the specified 1 Wire slave 28 User Manual Part 2 1 Wire Automation Server v1 0 0 Device Add Y IN DEV ADD OUT gt 452409 hbh4 451825 This command adds 1 Wire slave If the 1 Wire slave i
9. ce are not permitted 20 00000014C3CF 0E 20 14C3CF E 20 00000014C3CF 20 14C3CF 1 16707B5B When the server returns a client response it formats ROM codes consistently as follows 2 digit family code hyphen gt 12 digit serial number For example probe ch usb 4 2 1 1 20 00000014C3CF present HI The formatting of ROM codes in the responses from Dump commands may vary Remember that these responses are subject to change and are not meant for processing by software Adapter Identifier IN Adapter ID OUT OUT An adapter can be identified with its name or its number If string token is present it represents an adapter name The name is case sensitive If a number token is present it indicates an adapter number 1 12 User Manual Part 2 1 Wire Automation Server v1 0 0 Adapter Controller W BL BL controller Adapter Controller Channel W IN A C C OUT BL BL BL BL IN Adapter ID A controller m OUT controller channel User Manual Part 2 13 1 Wire Automation Server 1 Port Identifier 0 0 IN Y Port ID OUT Sg BL Br M rom code OUT Sensor Identifier BL E ee SENSOR T OUT ds18s20 ds2406 ds28e04 452423 14 User
10. e 38 Dump 39 Enumerate 39 FF32 40 FF34 40 FF 40 Hardware 41 Hardware Attribute 42 Hardware Attribute Detect 42 Hardware Attribute Enumerate 42 Hardware Disable 43 Hardware Enable 43 Hardware Remove 43 LibUSB 44 License 44 NPD 45 User Manual Part 2 3 1 Wire Automation Server v1 0 0 Port 45 Probe 46 Quit 46 Report 47 Report Sensed 47 Report Topology 48 Report Hardware 48 Topology 49 UCH 50 UCH Add 50 UCH Attribute 51 UCH Purge 51 UCH Remove 52 Untie 52 Version 53 Wait 53 7 Legal Information 54 Disclaimer 54 Trademarks 54 8 Contact Information 54 Revision History Date Authors Description 2015 03 06 Peter S heeren Initial release 4 User Manual Part 2 1 Wire Automation Server v1 0 0 1 Overview This part documents the commands and responses that are defined in the client protocol implemented by the 1 Wire Automation Server 2 Protocol Data Once client is connected to the server the client and the server transfer data bytes to each other Data in either direction is UTF 8 encoded and represents stream of Unicode characters The server processes received data bytes through number of stages to produce single line of text A text line contains zero or more commands and is described by the Command Text Line syntax block see section Command and Response Line below The stages are 1 UTF 8 decoder The incoming stream of data bytes is decoded to stream of Unicode character
11. e characters Comment Token A comment starts with a hash character and ends before the next end of line marker Comments are always discarded during the parsing stage 6 User Manual Part 2 1 Wire Automation Server v1 0 0 Comments come in handy when you put commands in a text file and you want to add useful remarks to the commands For example Add AbioWire adapter Let the server determine which interface to use i2c dev or BSC adapter ow add bscdetect abiowire Character Token This token represents single Unicode character The tokenizer assigns character token to every Unicode character that doesn t fit in any of the other tokens Examples Space character code 32 Tabulation character code 9 return code 13 Line feed code 10 Colon code 58 Note that carriage return and line feed are end of line markers Parser The parser checks the stream of tokens for valid syntax Valid syntax is documented with syntax flow diagrams If token doesn t fit in any flow a syntax error occurs Space and tabulation character tokens act as delimiters between other tokens A command may contain multiple space and tabulation characters consecutively The parser always discards comment tokens Note that a comment always concludes a text line User Manual Part 2 7 1 Wire Automation Server v1 0 0 3 Syntax Flow Diagrams Commands and responses are represented wi
12. haracter Note that UTF 8 is superset of ASCII 7 bit thus 1 byte values 0 127 are the same for UTF 8 and ASCII User Manual Part 2 5 1 Wire Automation Server v1 0 0 Tokenizer The tokenizer transforms the stream of Unicode characters into elements called tokens Each token represents one or more consecutive Unicode characters Note that all characters are subjected to tokenization never will a character be discarded Tokens are the most basic syntactical building blocks and greatly determine the overall syntax of commands and responses Label Token A label is composed of one or more characters First character A Z a z Consecutive characters A Z a z 0 9 Labels case insensitive Dog DOG and dog or interpreted the same Example labels Number Token A number is composed of one or more characters First character 0 9 Consecutive characters 0 9 A Z 2 Note that not all letters produce a valid number Underscores can be inserted to augment the readability of a number The last character determines the numeral system Decimal d or D Hexadecimal h or H Binary b or The default is decimal Numbers are case insensitive Leading zeroes or allowed The valid range of values is 0 4294967295 FFFFFFFFh Examples String Token A string token represents characters between two double quot
13. omation Server v1 0 0 7 Legal Information Disclaimer Axiris products are not designed authorized or warranted to be suitable for use in space nautical space military medical life critical or safety critical devices or equipment Axiris products are not designed authorized or warranted to be suitable for use in applications where failure or malfunction of an Axiris product can result in personal injury death property damage or environmental damage Axiris accepts no liability for inclusion or use of Axiris products in such applications and such inclusion or use is at the customer s own risk Should the customer use Axiris products for such application the customer shall indemnify and hold Axiris harmless against all claims and damages Trademarks Maxim Integrated is a trademark of Maxim Integrated Products Inc 1 Wire and iButton are registered trademarks of Maxim Integrated Products Inc Raspberry is trademark of the Raspberry Pi Foundation All product names brands and trademarks mentioned in this document are the property of their respective owners 8 Contact Information Official website http www axiris eu 54 User Manual Part 2
14. rdware Enable HW d ENABLE SR Disable all adapters This is a macro command Hardware Remove HW UN REMOVE LOUT Remove all adapters This is a macro command User Manual Part 2 43 1 Wire Automation Server v1 0 0 LibUSB VA IN LU OUT gt en License Y IN LICENSE OUT 7 LIN 0 9 LICENSE OUT license company 44 User Manual Part 2 1 Wire Automation Server v1 0 0 NPD Y IN NPD OUT gt 7 DG MOVE DG CLEAR Base command for performing tasks on the non present devices Port Y IN PORT OUT Port ID OUT CLEAR Base command for performing tasks specified hub port User Manual Part 2 45 1 Wire Automation Server v1 0 0 Probe VA ROM code b Probe the presence of a 1 Wire slave behind a channel The ROM code represents the target 1 Wire slave This macro command is expanded at the channel level Quit quit OUT Quits the server 46 User Manual Part 2 1 Wire Automation Server v1 0 0 Report Y IN REPORT gt OUT 7 REPORT This command controls
15. s The Unicode characters are buffered When an end of line EOL marker arrives the buffer is passed to the next stage 2 Tokenizer During this stage groups of consecutive Unicode characters are transformed into syntactical elements called tokens 3 Parser Tokens must be sequenced according to syntax rules so they form valid Command Text Line The parser applies these syntax rules to the stream of tokens During this stage each command that occurs in the line is added to the command queue Errors can occur at each stage If verbose output is enabled the server prints useful information in case of an error The server s command processor implements this level of complexity in order to cope with all possible input client may send all kinds of data including utter gibberish In all cases the server must persist A client is assumed to process incoming data bytes the same way Therefore the server sends responses using the same syntax rules that apply to commands Nevertheless the client can usually implement less complex model of processing since the server always formats its responses deterministically When the server sends response it never uses tabulation characters always space characters response never contains multiple consecutive space characters thus in places where whitespace is required the server always emits one space character UTF 8 Decoder The UTF 8 decoder converts 1 4 data bytes to Unicode c
16. s already present in the topology the command will be ignored Device Attribute 7 IN DEV ATTR OUT IN OUT DEV 4 POLL DEV ATTR FORCE PORTS DEV ATTR POWER MODE V DEV ATTR DESCRIPTION This command sets attributes of the specified 1 Wire slave User Manual Part 2 29 1 Wire Automation Server v1 0 0 Device Attribute Description DEV in DESCRIPTION n deser Jo our Device Attribute Force Ports DEV D FORCE PORTS SU Device Attribute Power Mode 30 DEV 1N POWER MODE ouy t external User Manual Part 2 1 Wire Automation Server v1 0 0 Device Attribute Poll DEV IN POLL OUT Device Locate IN DEV LOCATE OUT Device Located DEV LOCATED OUT anf vev our ROM code User Manual Part 2 31 1 Wire Automation Server v1 0 0 Device Move IN DEV MOVE OUT 7 Fi Device Ss Group QUT 32 User Manual Part 2 1 Wire Automation Server v1 0 0 Device PIO IN W PIO MASK OUT OUT IN DEV OUT
17. th syntax flow diagrams These diagrams are hierarchical in nature The macro block element embodies the concept of hierarchy VA V Macro Diagram Diagram Diagram Client command syntax Client response syntax Client command and diagram diagram response syntax diagram The background color indicates whether the diagram applies to command response or both The diagrams are composed of elements Label token Start of a text line Character token literal End of text line Character token code Entry to macro block port Number token Exit from macro block Next element one or String token more blank characters allowed required Next element no blank Comment token characters allowed 7 G Macro block H1 Space characters 32 and tabulation characters 9 21 This depends on which elements the arrow connects 8 User Manual Part 2 1 Wire Automation Server v1 0 0 4 Command and Response Line Command Text Line START COMMAND LINE 27 B E fee As mentioned earlier in section Protocol Data above the server decodes and buffers incoming UTF 8 characters until an end of line marker comes in stage 1 after which the resulting so called command text line is tokenized stage 2 and parsed stage 3 Example command text lines
18. the unsolicited responses the server sends to the client Use the command to add and remove pieces of information the client wants to receive Report Sensed REPORT SENSED OUT ROM code 1 Only with report add User Manual Part 2 47 1 Wire Automation Server v1 0 0 Report Topology REPORT IN TOPO OUT Report Hardware REPORT 48 User Manual Part 2 1 Wire Automation Server v1 0 0 Topology W IN TOPO OUT i utf8 B utfl6le l utfl6be Commands for loading and saving topology files User Manual Part 2 49 1 Wire Automation Server v1 0 0 UCH OUT 7 UCH ADD UCH PURGE d 7 UCH REMOVE UCH ATTR DG MOVE W DG CLEAR OUT Base command for performing tasks on unallocated channels UCH Add Add a new unallocated channel The newly added unallocated channel is empty meaning it contains no 1 Wire slaves 50 User Manual Part 2 1 Wire Automation Server v1 0 0 UCH Attribute Y IN UCH ATTR OUT Set attributes of unallocated channel Currently you can set the number identification slaves to be taken into account during detection procedure UCH Purge
19. uch purge adapter 1 enum hw enum block dump Enumerate the first 1 Wire adapter Enumerate all dump results when finished dev 28 40CBBB2 add dev 28 40CBBB2 attr poll on 60000 User Manual Part 2 1 Wire Automation Server v1 0 0 Command 27 COMMAND OUT Y ADAPTER W CANCEL W CLOSE W LICENSE DEV DUMP FF32 W W W HW REPORT LU Y NPD VERSION QUIT FF34 Note that the following commands aren t available in the free version of the server 10 auth npd port topo User Manual Part 2 1 Wire Automation Server v1 0 0 Response Text Line 7 START RESPONSE LINE END Response 7 RESPONSE W W DETECT LICENSE W DEV PROBE 7 UNTIE 7 Y The responses the server produces User Manual Part 2 11 1 Wire Automation Server v1 0 0 5 Common Syntax ROM Code When you specify ROM code in client command the 8 bit family code and 48 bit serial number are mandatory the 8 bit CRC is optional If you do specify a CRC value then it must be valid else the client command is considered invalid The ROM code resides in string token The values are hexadecimal digits leading zeroes are allowed The values must be separated by hyphen characters Other characters including whitespa
Download Pdf Manuals
Related Search