1-Wire Automation Server v1.1.0
Contents
1. Run the detection procedure for a controller optionally confined to a single channel This macro command is expanded at the controller level 28 User Manual Part 2 1 Wire Automation Server v1 1 0 Device ROM code 7 DEV ADD OUT C DEV REMOVE C j DEV MOVE C E DEV SENSE i C h DEV PIO j 4 b DEV RGBCTRL i C b DEV SWITCH i C DEV ATTR 7 DEV LOCATE Base command for performing tasks on the specified 1 Wire slave User Manual Part 2 29 1 Wire Automation Server v1 1 0 Device Add V IN DEV ADD OUT gt g ds2409 i i hbh4 i ds1825 This command adds a 1 Wire slave If the 1 Wire slave is already present in the topology the command will be ignored Device Attribute C IN DEV ATTR OUT IN OUT DEV ATTR D POLL C DEV ATTR FORCE PORTS C DEV ATTR POWER MODE C DEV ATTR DESCRIPTION This command sets attributes of the specified 1 Wire slave 30 User Manual Part 2 1 Wire Automation Server v1 1 0 Device Attribute Description C DEV ATTR alati our Device Attribute Force Ports Y DEV ATIR in FORCE PORTS SUN Device Attribute Power Mode C DEV ATTR IN POWER MODE OUT external User Manual Part 22. Base command for performing tasks on unallocated channels UCH Add IN V UCH ADD OUT OUT Add a new unallocated channel The newly added unallocated channel is empty meaning it contains no 1 Wire slaves User Manual Part 2 51 1 Wire Automation Server v1 1 0 UCH Attribute Y IN UCH ATTR OUT n Tea Set attributes of an unallocated channel Currently you can set the number of non identification slaves to be taken into account during a detection procedure UCH Purge IN UCH PURGE OUT Client command UCH Purge removes all empty unallocated channels Empty unallocated channels usually pile up when a 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 52 User Manual Part 2 1 Wire Automation Server v1 1 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
3. 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 User Manual Part 2 53 1 Wire Automation Server v1 1 0 U401 U421 U451 USBMICRO V IN U401 OUT V V IN U421 OUT V IN u421 USBMICRO OUT V IN U451 OUT V IN u451 USBMICRO OUT IN V USBMICRO OUT IN default serial number 54 User Manual Part 2 1 Wire Automation Server v1 1 0 Version Y IN VERSION OUT A 7 IN gt VERSION OUT gt version program version This command responds with version information Currently the program version of the server is returned as a major minor micro triplet Wi V Wait V IN WAIT OUT User Manual Part 2 55 1 Wire Automation Server v1 1 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 i
4. Attribute cancel romcode 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 Label romcode selects the formatting of ROM codes in client responses User Manual Part 2 25 1 Wire Automation Server v1 1 0 Authentication V IN AUTH OUT Block Cancel V IN CANCEL OUT OUT 26 User Manual Part 2 1 Wire Automation Server v1 1 0 Channel IN CH OUT gt 7 DG MOVE C DG CLEAR C i DETECT j C i ENUM i C UNTIE DID 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 User Manual Part 2 27 1 Wire Automation Server v1 1 0 Controller 7 DETECT 4 ENUM C UNTIE V PROBE Detect V IN DETECT OUT
5. Device Sensed mfo sso Har ROM code User Manual Part 2 37 1 Wire Automation Server v1 1 0 Device Switch DG Clear IN V DEV SWITCH OUT V IN DG CLEAR OUT v OUT Clear a device group All 1 Wire slaves in the device group are removed thus become unknown to the server DG Move V IN DG MOVE OUT C Device Move a device group to another location in the topology 38 User Manual Part 2 1 Wire Automation Server v1 1 0 Done This response is generated when a command with an identifier has completed User Manual Part 2 39 1 Wire Automation Server v1 1 0 Dump Enumerate V IN DUMP OUT af topo OUT Enumerate 1 Wire slaves residing behind a channel This macro command is expanded at the channel level 40 User Manual Part 2 1 Wire Automation Server v1 1 0 FF32 Y V FF34 Y V FF V IN FF OUT CY User Manual Part 2 41 1 Wire Automation Server v1 1 0 Hardware nf Har UT C HW l REMOVE C HW ENABLE C HW DISABLE 5 DETECT 7 j ENUM i C UNTIE V PROBE OUT 42 User Manual Part 2
6. 1 Wire Automation Server v1 1 0 Hardware Attribute Set hardware attributes Hardware Attribute Detect HW ATTR DN DETECT cun OUT Turn on or off automatic detection for all adapters Hardware Attribute Enumerate C HW ATTR IN ENUM OUT Turn on or off automatic enumeration for all adapters User Manual Part 2 43 1 Wire Automation Server v1 1 0 Hardware Disable V HW UN DISABLE gU Enable all adapters This is a macro command Hardware Enable C HW a ENABLE out Disable all adapters This is a macro command Hardware Remove C HW D REMOVE LOVT Remove all adapters This is a macro command 44 User Manual Part 2 1 Wire Automation Server v1 1 0 LibUSB V IN LU OUT gt on License V IN LICENSE OUT 7 LIN gt LICENSE OUT license User Manual Part 2 45 1 Wire Automation Server v1 1 0 NPD V IN NPD OUT 7 DG MOVE C DG CLEAR Base command for performing tasks on the non present devices Port V IN PORT OUT Port ID OUT V DG MOVE V DG CLEAR Base command for performing tasks on a specified hub po
7. Decimal d or D Hexadecimal h or H Binary b or B 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 quote 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 1 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 a single Unicode character The tokenizer assigns a 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 Carriage 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 a token doesn t fit in any flow a syntax error occurs Space and tabulation character tokens act as delimiters between other tokens A comman
8. tasks 18 User Manual Part 2 1 Wire Automation Server v1 1 0 Adapter Add QE Hom Fast C ADAPTER serial path ADD SERIAL C ADAPTER ADD I2C bscdetect hostname number 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 that are executed immediately instead of being queued User Manual Part 2 19 1 Wire Automation Server v1 1 0 Adapter Add I2C C ADAPTER IN ADD I2C QUI ds2482 mnu3 This syntax describes one or more I2C slaves that reside on the same I2C bus and make up a 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 a device node The ds2482 label is used for DS2482 100 and DS2482 800 controllers The server distinguishes between these controllers when the built in DS2482 driver is enabling the chip slave ad The abiowire label covers AbioWire and AbioWire adapters These adapter
9. 1 Wire Automation Server v1 1 0 User Manual Part 2 June 2015 1 Wire Automation Server v1 1 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 Native Formatting Style owfs Formatting Style Adapter Identifier Adapter Controller Adapter Controller Channel Port Identifier Sensor Identifier Short Response Identifier Device Group 6 Commands 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 5 NN h Gh 10 10 a Un VI 00 9 9 10 11 11 12 12 12 12 13 14 14 15 15 16 17 18 18 19 20 21 22 22 22 23 23 User Manual Part 2 1 Wire Automation Server v1 1 0 Adapter Disable 23 Adapter Enable 24 Adapter Remove 24 Attribute 25 Authentication 26 Block 26 Cancel 26 Channel 27 Close 27 Controller 28 Detect 28 Device 29 Device Add 30 Device Attribute 30 Device Attribute Description 31 Device Attribute Force Ports 31 Device Attribute Power Mode 31 Device Attribute Poll 32 Device Locate 32 Device Located 32 Device Move 33 Device PIO 34 Device Remove 35 Device RGB Controller 36 Device Sense 37 Device Se
10. 31 1 Wire Automation Server v1 1 0 Device Attribute Poll C DEV ATTR IN POLL OUT Device Locate V IN DEV LOCATE OUT Device Located DEV LOCATED OUT N Dev Locareo a ROM code J Group 32 User Manual Part 2 1 Wire Automation Server v1 1 0 Device Move L IN DEV MOVE OUT 7 B Device i Group QUT User Manual Part 2 33 1 Wire Automation Server v1 1 0 Device PIO IN V PIO MASK OUT OUT IN V DEV PIO OUT i i PIO MASK i 7 off PIO MASK 34 User Manual Part 2 1 Wire Automation Server v1 1 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 User Manual Part 2 35 1 Wire Automation Server v1 1 0 Device RGB Controller V IN COLOR MASK OUT OUT V IN DEV RGBCTRL OUT V COLOR MASK V COLOR MASK V COLOR MASK 36 User Manual Part 2 1 Wire Automation Server v1 1 0 Device Sense V IN DEV SENSE OUT IN OUT i ge RSP ID
11. d 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 1 0 3 Syntax Flow Diagrams Commands and responses are represented with syntax flow diagrams These diagrams are hierarchical in nature The macro block element embodies the concept of hierarchy C Macro V Macro C Macro IN OUT HS block OUT IN Keh OUT 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 a command a response or both The diagrams are composed of elements Label token Start of a text line Character token literal End of a text line Number token Exit from macro block Character token code Entry to macro block Con Next element one or String token more blank characters allowed required Next element no blank Comment token characters allowed 7 dia Macro block H1 Space characters 32 and tabulation characters 9 2 This depends on which elements the arrow connects 8 User Manual Part 2 1 Wire Automation Server v1 1 0 4 Command and Response Line Command Text Line START COMMAND LINE 7 V Lan ee As
12. e 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 a string token The values are hexadecimal digits leading zeroes are allowed The values must be separated by hyphen characters Other characters including whitespace 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 gt hyphen 12 digit serial number For example probe ch usb 4 2 1 1 20 00000014C3CF present 1 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 owfs Formatting Style This formatting style is the same for commands and responses 2 digit family code dot 12 digit serial number in reversed byte order Example command and response hw probe 26 48496B010000 probe ch usb 1 2 1 1 26 48496B010000 present 12 User Manual Part 2 1 Wire Automation Server v1 1 0 Adapter Identifier V IN Adapter ID OUT An adapter can be identified with its name or its number If a 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 U
13. 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 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 1 0 Command L IN V V V V VERSION V V CANCEL WI Y E CH i WAIT C CLOSE OUT The following commands aren t available in the free version of the server auth npd port topo 10 User Manual Part 2 1 Wire Automation Server v1 1 0 Response Text Line DZ START RESPONSE LINE END Response 7 RESPONSE V V DETECT LICENSE V DEV PROBE 7 V DONE UNTIE 7 V The responses the server produces User Manual Part 2 11 1 Wire Automation Server v1 1 0 5 Common Syntax ROM Code A ROM code is specified inside a string token ROM codes occur in client gt commands and responses The client protocol defines two formatting styles native and owfs Native Formatting Style When you specify a ROM code in a client command the 8 bit family code and 48 bit serial number ar
14. njury 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 Pi is a 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 56 User Manual Part 2
15. nsed 37 Device Switch 38 DG Clear 38 DG Move 38 Done 39 Dump 40 Enumerate 40 FF32 41 FF34 41 FF 41 Hardware 42 Hardware Attribute 43 Hardware Attribute Detect 43 Hardware Attribute Enumerate 43 Hardware Disable 44 Hardware Enable 44 Hardware Remove 44 LibUSB 45 User Manual Part 2 3 1 Wire Automation Server v1 1 0 License 45 NPD 46 Port 46 Probe 47 Quit 47 Report 48 Report Sensed 48 Report Topology 49 Report Hardware 49 Topology 50 UCH 51 UCH Add 51 UCH Attribute 52 UCH Purge 52 UCH Remove 53 Untie 53 U401 54 U421 54 U451 54 USBMICRO 54 Version 55 Wi 55 Wait 55 7 Legal Information 56 Disclaimer 56 Trademarks 56 8 Contact Information 56 Revision History Date Authors Description 2015 03 06 Peter S heeren Initial release 2015 06 16 Peter S heeren Added USBMicro client commands Added W1 client command Added ROMCode to Attribute client command Added TMEX to Adapter Add client command Second release 4 User Manual Part 2 1 Wire Automation Server v1 1 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 a 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 a stream of Unicode characters The server processes received data bytes through a number of
16. rt 46 User Manual Part 2 1 Wire Automation Server v1 1 0 Probe V ROM code 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 V IN quit OUT Quits the server User Manual Part 2 47 1 Wire Automation Server v1 1 0 Report IN calci 7 REPORT OUT This command controls 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 48 C REPORT un SENSED SUT ROM code Hl Only with report add User Manual Part 2 1 Wire Automation Server v1 1 0 Report Topology V REPORT IN TOPO OUT Report Hardware C REPORT User Manual Part 2 49 1 Wire Automation Server v1 1 0 Topology V IN TOPO OUT utf8 utfl le i utf16be Commands for loading and saving topology files 50 User Manual Part 2 1 Wire Automation Server v1 1 0 UCH OUT 7 UCH ADD C f UCH PURGE i 7 i UCH REMOVE i C i UCH ATTR i C DG MOVE V DG CLEAR OUT
17. s are software compatible The label results in the addition of three device nodes Labels mnu mnu0 mnu1 mnu2 and mnu3 target m nu 1 Wire adapters 20 User Manual Part 2 1 Wire Automation Server v1 1 0 Adapter Add Serial V ADAPTER IN ADD SERIAL OUT This syntax describes a 1 Wire master with serial interface User Manual Part 2 21 1 Wire Automation Server v1 1 0 Adapter Attribute 7 ADAPTER D FE r gt C ADAPTER ATTR RECONN ADAPTER ATTR ENUM ADAPTER d ATTR DETECT C ADAPTER ATTR NAME Adapter Attribute Detect C ADAPTER UN ATTR DETECT OUT gt Adapter Attribute Enumerate 22 C ADAPTER UN ATTR ENUM OUT gt e off OUT User Manual Part 2 1 Wire Automation Server v1 1 0 Adapter Attribute Name ADAPTER fom ar Adapter Attribute Reconnect C ADAPTER in ATTR RECONN OU interval OUT Adapter Disable V ADAPTER un DISABLE SUN User Manual Part 2 23 1 Wire Automation Server v1 1 0 Adapter Enable V ADAPTER UN ENABLE Gu Adapter Remove V ADAPTER UN REMOVE ES 24 User Manual Part 2 1 Wire Automation Server v1 1 0
18. ser Manual Part 2 13 1 Wire Automation Server v1 1 0 OUT Adapter Controller V IN A C IN V BL BL rt PC OUT controller Adapter Controller Channel 14 IN V A C C OUT V BL BL BL BL IN Adapter ID A controller o OUT controller channel User Manual Part 2 1 Wire Automation Server v1 Port Identifier 1 0 IN V Port ID OUT a BI BL nD Rom code PL OUT Sensor Identifier TREE BL BL E OUT C SENSOR IN ds18s20 ds2406 ds28e04 ds2423 i User Manual Part 2 15 1 Wire Automation Server v1 1 0 Short Response Identifier C SHORT IN OUT sensorid minute second va i piosensed tccold vd pioset tcfault vi i i rstz i aina entra d d j OUT 16 User Manual Part 2 1 Wire Automation Server v1 1 0 Device Group User Manual Part 2 OUT 17 1 Wire Automation Server v1 1 0 6 Commands and Responses Adapter V IN ADAPTER OUT Adapter ID V ADAPTER REMOVE V ADAPTER ENABLE ADAPTER DISABLE ADAPTER ATTR C b DETECT i C ENUM C UNTIE V PROBE Base command for performing adapter related
19. sponse it never uses tabulation characters always space characters A 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 a Unicode character Note that UTF 8 is a 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 1 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 or _ Consecutive characters A Z a z 0 9 _ Labels are 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 a z _ 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
20. stages to produce a 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 a stream of Unicode characters 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 a 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 A 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 a less complex model of processing since the server always formats its responses deterministically When the server sends a re
Download Pdf Manuals
Related Search