Quick-Start/en - Versionsgeschichte

Drhirn: veraltete "source"-Angaben in "syntaxhighlight" geändert

2023-11-09T10:50:38Z

veraltete "source"-Angaben in "syntaxhighlight" geändert

← Nächstältere Version		Version vom 9. November 2023, 12:50 Uhr
Zeile 6:		Zeile 6:
	Having started FHEM the first time, please have a look at the FHEM logfile<ref>In most cases you'll find the log in <code>/opt/fhem/log</code></ref><ref>Most installations use Linux as operating system for the server. So if not stated differently, the commands and examples provided here use the syntax for Linux</ref>. The log file will look something like the following example:		Having started FHEM the first time, please have a look at the FHEM logfile<ref>In most cases you'll find the log in <code>/opt/fhem/log</code></ref><ref>Most installations use Linux as operating system for the server. So if not stated differently, the commands and examples provided here use the syntax for Linux</ref>. The log file will look something like the following example:

	<~~source~~ lang="text">		<syntaxhighlight lang="text">
	2018.03.09 09:17:51 1: Including fhem.cfg		2018.03.09 09:17:51 1: Including fhem.cfg
	2018.03.09 09:17:51 3: telnetPort: port 7072 opened		2018.03.09 09:17:51 3: telnetPort: port 7072 opened
Zeile 18:		Zeile 18:
	2018.03.09 09:17:51 0: Featurelevel: 5.8		2018.03.09 09:17:51 0: Featurelevel: 5.8
	2018.03.09 09:17:51 0: Server started with 9 defined entities (fhem.pl:16349/2018-03-07 perl:5.024001 os:linux user:fhem pid:9341)		2018.03.09 09:17:51 0: Server started with 9 defined entities (fhem.pl:16349/2018-03-07 perl:5.024001 os:linux user:fhem pid:9341)
	</~~source~~>		</syntaxhighlight>

	==Talking to FHEM==		==Talking to FHEM==

Ph1959de: fakelog durch Logfile ersetzt

2021-11-22T11:18:59Z

fakelog durch Logfile ersetzt

← Nächstältere Version		Version vom 22. November 2021, 13:18 Uhr
Zeile 203:		Zeile 203:
	There's also a (German) article [[Plots_erzeugen\|Plots erzeugen]] that will direct you to some practical examples. For further information also look at the commandref's {{Link2CmdRef\|Anker=SVG\|Lang=en\|Label=SVG}} section.		There's also a (German) article [[Plots_erzeugen\|Plots erzeugen]] that will direct you to some practical examples. For further information also look at the commandref's {{Link2CmdRef\|Anker=SVG\|Lang=en\|Label=SVG}} section.

	To include data in your diagrams not directly logged from within FHEM, add ~~a fake logfile~~. Make sure that there are no other devices named identically and enter something like the following to the command field:		To include data in your diagrams not directly logged from within FHEM, add the ''readonly'' parameter to the FileLog definition. Make sure that there are no other devices named identically and enter something like the following to the command field (usually '''''<regexp>''''' needs to be identical to the device name, i.e. '''''messages''''' in this case):
			:<code>define messages FileLog /var/log/messages <regexp> readonly </code>

	~~define messages FileLog /var/log/messages fakelog~~		== Frontends: Adopting the web interface to your needs ==

	==Frontends: Adopting the web interface to your needs==
	So far [[FHEMWEB]] - to be exact FHEMWEB's default style "f18" has been used as user interface between you and the FHEM server. "f18" is capable to adopt the web sites to different display sizes for all kind of gadgets like mobile phones, tablets or computers.		So far [[FHEMWEB]] - to be exact FHEMWEB's default style "f18" has been used as user interface between you and the FHEM server. "f18" is capable to adopt the web sites to different display sizes for all kind of gadgets like mobile phones, tablets or computers.
	=== Styles ===		=== Styles ===

Hb: Link to "Heimautomatisierung mit ..." broken by exclamation mark

2021-02-01T20:37:40Z

Link to "Heimautomatisierung mit ..." broken by exclamation mark

← Nächstältere Version		Version vom 1. Februar 2021, 22:37 Uhr
Zeile 133:		Zeile 133:
	==Basics about controlling your devices==		==Basics about controlling your devices==
	Once your sensors and actors are correctly defined in FHEM you will be able to control any of your actors using FHEM's telnet or web interface.		Once your sensors and actors are correctly defined in FHEM you will be able to control any of your actors using FHEM's telnet or web interface.
	{{Randnotiz\|RNTyp=b\|RNText=If you start with FHEM and are able to read German, it's recommended to read the [http://fhem.de/Heimautomatisierung-mit-fhem.pdf! Einführung in die Automatisierung mit FHEM]. This document is - beside some details - still up to date. Although new features like the f18 style, modules like {{Link2CmdRef\|Anker=allowed\|Label=allowed}} or {{Link2CmdRef\|Anker=DOIF\|Label=DOIF}} are not covered there, and the selection of available hardware systems has continued to increase since its last update. Nevertheless, this introduction still offers a quite comprehensive overview of the general procedures and possibilities with FHEM.		{{Randnotiz\|RNTyp=b\|RNText=If you start with FHEM and are able to read German, it's recommended to read the [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Einführung in die Automatisierung mit FHEM]. This document is - beside some details - still up to date. Although new features like the f18 style, modules like {{Link2CmdRef\|Anker=allowed\|Label=allowed}} or {{Link2CmdRef\|Anker=DOIF\|Label=DOIF}} are not covered there, and the selection of available hardware systems has continued to increase since its last update. Nevertheless, this introduction still offers a quite comprehensive overview of the general procedures and possibilities with FHEM.

	The module DOIF has only a short {{Link2CmdRef\|Anker=DOIF\|Label=English commandref}}. The complete commandref is provided by the module maintainer only in {{Link2CmdRef\|Anker=DOIF\|Lang=de\|Label=German with several example codes}}. If you can't understand this or don't want to get used to DOIF for this reason: you can use the full functionality of FHEM without DOIF. Use for example {{Link2CmdRef\|Anker=notify\|Label=notify}}, {{Link2CmdRef\|Anker=at\|Label=at}} and the other modules instead.}}		The module DOIF has only a short {{Link2CmdRef\|Anker=DOIF\|Label=English commandref}}. The complete commandref is provided by the module maintainer only in {{Link2CmdRef\|Anker=DOIF\|Lang=de\|Label=German with several example codes}}. If you can't understand this or don't want to get used to DOIF for this reason: you can use the full functionality of FHEM without DOIF. Use for example {{Link2CmdRef\|Anker=notify\|Label=notify}}, {{Link2CmdRef\|Anker=at\|Label=at}} and the other modules instead.}}

Beta-User: Fhem ist ein... eingefügt

2019-05-27T11:44:07Z

Fhem ist ein... eingefügt

← Nächstältere Version		Version vom 27. Mai 2019, 13:44 Uhr
Zeile 240:		Zeile 240:
	*{{Link2CmdRef\|Anker=cancel\|Lang=en\|Label=cancel}}		*{{Link2CmdRef\|Anker=cancel\|Lang=en\|Label=cancel}}
	*{{Link2CmdRef\|Anker=watchdog\|Lang=en\|Label=watchdog}} - ([[watchdog\|Wiki]])		*{{Link2CmdRef\|Anker=watchdog\|Lang=en\|Label=watchdog}} - ([[watchdog\|Wiki]])

			==FHEM (TM) is a GPL'd perl server...==
			As FHEM is written in perl, most users will be reminded of it's perl nature at some point in time. Though it may not be mandatory for FHEM users to learn perl, it's highly recommended to also have a look at this programming language for getting deeper insights in what is going on in your home automation system. As often [[Regulärer Ausdruck\|regular expressions (german)]] are used within the perl code, getting familiar with this toolset is also a good idea. To solve some problems you may encounter using perl and regex is the most efficient way to go.
			For first insight see {{Link2CmdRef\|Anker=command\|Lang=en\|Label=FHEM command types}}, {{Link2CmdRef\|Anker=perl\|Lang=en\|Label=Perl specials}} and the article [[99 myUtils anlegen\|99 myUtils anlegen (german)]]. Despite beeing marked as outdated, [[DevelopmentIntroduction\|this article]] and others in this sections still privide usefull futher info in English to more experienced users and experts.

	==References==		==References==

Beta-User: Übersetzung ergänzt wg. RAW etc.

2019-04-26T14:30:24Z

Übersetzung ergänzt wg. RAW etc.

← Nächstältere Version		Version vom 26. April 2019, 16:30 Uhr
Zeile 35:		Zeile 35:
	;Elements of the web interface:		;Elements of the web interface:
	*The input box at the top is used to enter commands and here referred to as "command field". Finish your typing with {{Taste\|Enter}} to pass the commands to FHEM for processing.		*The input box at the top is used to enter commands and here referred to as "command field". Finish your typing with {{Taste\|Enter}} to pass the commands to FHEM for processing.
			*Left of the command field there's a symbol (+). Clicking will prompt a popup field to enter [[Import von Code Snippets\|RAW-Code]] - a very effective way to enter multiple command lines in one step.
	*The menu on the left starts with the item ''Save config''. FHEM allows to change its configuration at runtime. To make changes permanent and keep them available after restart of FHEM or the server hardware also, they have to be written to a configuration file<ref>In most cases this is a text file, but you may also use a database. See {{Link2CmdRef\|Anker=configDB\|Lang=en\|Label=configDB}} for how to use a database as configuration source</ref>. If you see a red ''?'' beneath this menu item, this indicates unsaved changes of your configuration.		*The menu on the left starts with the item ''Save config''. FHEM allows to change its configuration at runtime. To make changes permanent and keep them available after restart of FHEM or the server hardware also, they have to be written to a configuration file<ref>In most cases this is a text file, but you may also use a database. See {{Link2CmdRef\|Anker=configDB\|Lang=en\|Label=configDB}} for how to use a database as configuration source</ref>. If you see a red ''?'' beneath this menu item, this indicates unsaved changes of your configuration.
	*Below "Save config" is a section listing the "rooms" known by FHEM. At first start you will only find the rooms ''Unsorted'' and ''Everything''. New rooms will automatically appear if you assign the respective attribute<ref>Further informationen on the terminology used in a FHEM context is provided in our [[:Kategorie:Glossary\|glossary (german)]]</ref> to the devices<ref>Please note: The term "'''device'''" is often used used in the FHEM context in a special way. This could - but must not necessarily be - a physical piece of equipment. "Device" just is a term for any physical or virtual "object" that can be introduced in a FHEM system by a ''define'' or ''defmod'' command.</ref> you add later on.		*Below "Save config" is a section listing the "rooms" known by FHEM. At first start you will only find the rooms ''Unsorted'' and ''Everything''. New rooms will automatically appear if you assign the respective attribute<ref>Further informationen on the terminology used in a FHEM context is provided in our [[:Kategorie:Glossary\|glossary (german)]]</ref> to the devices<ref>Please note: The term "'''device'''" is often used used in the FHEM context in a special way. This could - but must not necessarily be - a physical piece of equipment. "Device" just is a term for any physical or virtual "object" that can be introduced in a FHEM system by a ''define'' or ''defmod'' command.</ref> you add later on.
Zeile 206:		Zeile 207:
	define messages FileLog /var/log/messages fakelog		define messages FileLog /var/log/messages fakelog

	==~~Frontend~~: Adopting ~~FHEMWEB (pgm2)~~ to your needs==		==Frontends: Adopting the web interface to your needs==
			So far [[FHEMWEB]] - to be exact FHEMWEB's default style "f18" has been used as user interface between you and the FHEM server. "f18" is capable to adopt the web sites to different display sizes for all kind of gadgets like mobile phones, tablets or computers.
			=== Styles ===
			To change FHEMWEB's look and feel, you may choose other color shemes or styles. You are not limited to just one scheme, but may use different styles or color schemes for different FHEMWEB instanzes<ref>Just use a different port for each of them</ref>. So you may see at one glance, if you are using a more administrative instance or just a very limited instance with just a few devices to interact<ref>For more info see commandref: {{Link2CmdRef\|Anker=FHEMWEB\|Lang=en\|Label=FHEMWEB}} bzw. {{Link2CmdRef\|Anker=allowed\|Lang=en\|Label=allowed}}</ref>.

	===Rooms and groups===		===Rooms and groups===
			It makes sense to group your devices for structured access in FHEMWEB by setting the ''room'' and/or ''group<ref>To sort groups use the ''sortby'' attribute.</ref> ''attributes, attribute ''defaultRoom'' will mark a starting page. FHEMWEB puts devices without a ''room'' attribute into the "Unsorted" room, new room names will be added to the menu on the left<ref>For even more structuring options in rooms use the delimiter "->". This will generate sub-rooms, e.g. <code>attr <device> room MyLogics->Light</code>.</ref> . Devices in the room "hidden" will not be shown by default.
	It makes sense to group your devices for structured access in FHEMWEB by setting the ''room'' and/or ''group'' attributes. FHEMWEB puts devices without a ''room'' attribute into the "Unsorted" room, new room names will be added to the menu on the left. Devices in the room "hidden" will not be shown by default.

	You can also define a stripped down FHEMWEB instance by defining the menu entries to be hidden in the ''hiddenroom'' FHEMWEB attribute.		You can also define a stripped down FHEMWEB instance by defining the menu entries to be hidden in the ''hiddenroom'' FHEMWEB attribute.
Zeile 218:		Zeile 221:
	===More options on the frontend side===		===More options on the frontend side===
	FHEMWEB offers a new style, called '''[https://forum.fhem.de/index.php?topic=82351.0 f18]'''. This overcomes the need for several FHEMWEB instances for different screen sizes. Give it a try!		FHEMWEB offers a new style, called '''[https://forum.fhem.de/index.php?topic=82351.0 f18]'''. This overcomes the need for several FHEMWEB instances for different screen sizes. Give it a try!
	Using a completely different frontend is also possible. Browse the wiki ~~and the~~ forum to find the solution that fits your needs best!		Using a completely different frontend is also possible. Browse the wiki or forum board ''FHEM » Frontends'' to find the solution that fits your needs best!

	==Complex structures==		==Complex structures==

Beta-User: Reihenfolge der Bilder geändert

2019-01-03T12:35:21Z

Reihenfolge der Bilder geändert

← Nächstältere Version		Version vom 3. Januar 2019, 14:35 Uhr
Zeile 27:		Zeile 27:

	<gallery>		<gallery>
	~~Datei:Erster_aufruf_telnet.png\|A new telnet connection after issuing a ''version'' command~~
	datei:ErsteSchritteInFhem01.png\|Desktop version of the FHEM start screen just after installation		datei:ErsteSchritteInFhem01.png\|Desktop version of the FHEM start screen just after installation
	datei:erster_aufruf_smartphone.png\|Smallscreen version of the start screen		datei:erster_aufruf_smartphone.png\|Smallscreen version of the start screen
			Datei:Erster_aufruf_telnet.png\|A new telnet connection after issuing a ''version'' command
	</gallery>		</gallery>

Beta-User: /* Talking to FHEM */ 5.9 rewrite

2019-01-03T12:33:40Z

Talking to FHEM: 5.9 rewrite

← Nächstältere Version		Version vom 3. Januar 2019, 14:33 Uhr
Zeile 21:		Zeile 21:

	==Talking to FHEM==		==Talking to FHEM==
	FHEM ~~offers two ways to interact and configure itself.~~		After installation, FHEM can be accessed by a {{Link2CmdRef\|Anker=FHEMWEB\|Lang=en\|Label=FHEMWEB}}interface to be found at the following URL:
	~~#A [[Telnet\|telnet]] interface at port 7072~~		'''http://<fhem-server>:8083/fhem'''
	~~#Websites (~~{{Link2CmdRef\|Anker=FHEMWEB\|Lang=de\|Label=FHEMWEB}}) found at the following ~~three locations~~:
	#*'''http://<fhem-server>:8083/fhem''' ~~for normal desktop computer screen sizes~~
	~~#*'''http://<fhem-server>:8084/fhem''' for Smartphones and other devices with small display sizes~~
	~~#*'''http://<fhem-server>:8085/fhem''' for other mobile devices with medium display sizes like tablet PC's~~

			{{Hinweis\|You may add more FHEMWEB devices. This may be helpfull in case you want to use a different style than default ''f18'' on smaller display sizes or provide pages with limited options to controll FHEM for other users. In case you need a lower level communication channel to FHEM, e.g. for scripting or emergancy cases, have a look at [[Telnet\|telnet]].}}

	<gallery>		<gallery>

AndreasMohr: Misc.

2018-12-31T20:37:07Z

Misc.

← Nächstältere Version		Version vom 31. Dezember 2018, 22:37 Uhr
Zeile 63:		Zeile 63:

	===Additional remarks on security===		===Additional remarks on security===
	Please note: Running a server system requires regular updates on the operating system and other software components installed on it. Besides that, any other components you use for home automation will contribute to the level of security of the entire system you run in the end.		Please note: Running a server system requires regular updates to the operating system and other software components installed on it. Besides that, any other components you use for home automation will contribute to the level of (non-)security of the entire system you run in the end.

	==Interfaces to the real world==		==Interfaces to the real world==
Zeile 73:		Zeile 73:
	By default FHEM will try to identify commonly used USB devices like FHZ, CUL<ref>In a Linux environment, FHEM will also try to flash an attached CUL in case it's not yet programmed with firmware. For details see the descriptions of the commands <code>usb</code> and <code>CUL flash</code> in commandref.</ref>, COC, ZWave or TCM. These just have to be attached when FHEM is starting to have FHEM write the respective parts to its configuration file. When attaching devices to a running FHEM you have to issue a <code>shutdown restart</code> in the command field to start the auto configuration.		By default FHEM will try to identify commonly used USB devices like FHZ, CUL<ref>In a Linux environment, FHEM will also try to flash an attached CUL in case it's not yet programmed with firmware. For details see the descriptions of the commands <code>usb</code> and <code>CUL flash</code> in commandref.</ref>, COC, ZWave or TCM. These just have to be attached when FHEM is starting to have FHEM write the respective parts to its configuration file. When attaching devices to a running FHEM you have to issue a <code>shutdown restart</code> in the command field to start the auto configuration.

	Typically you'll have to ~~make~~ additional configuration work also for automatically detected devices by assigning the appropriate values to attributes. You can easily get an overview of the available attributes and to some ~~extend~~ also a set of values for them by just clicking the name of the device shown in the respective room. New devices in most cases can be found in the room ''Unsorted''.		Typically you'll have to do additional configuration work also for automatically detected devices by assigning the appropriate values to attributes. You can easily get an overview of the available attributes and to some extent also a set of values for them by just clicking the name of the device shown in the respective room. New devices in most cases can be found in the room ''Unsorted''.

	Once you have basic definitions of all of your USB devices it's recommended to deactivate the automatic recognition of USB devices by entering <code>attr initialUsbCheck disable 1</code> to the command field.		Once you have basic definitions of all of your USB devices it's recommended to deactivate the automatic recognition of USB devices by entering <code>attr initialUsbCheck disable 1</code> to the command field.

AndreasMohr: Typos/Spelling

2018-12-31T20:34:36Z

Typos/Spelling

Änderungen zeigen

AndreasMohr: Syntax issues

2018-12-31T20:21:45Z

Syntax issues

← Nächstältere Version		Version vom 31. Dezember 2018, 22:21 Uhr
Zeile 50:		Zeile 50:

	{{Randnotiz\|RNTyp=b\|RNText=For instructions on how to use FHEM commands and additional info just type <code>help <command></code> in the command field and press {{Taste\|Enter}}.}}		{{Randnotiz\|RNTyp=b\|RNText=For instructions on how to use FHEM commands and additional info just type <code>help <command></code> in the command field and press {{Taste\|Enter}}.}}
	It is recommended to define one or more ''allowed'' devices. For instructions on how to do this, please have a look in our{{Link2CmdRef\|Anker=allowed\|Lang=en\|Label=CommandRef}} or just pass <code>help allowed</code> to the command field.		It is recommended to define one or more ''allowed'' devices. For instructions on how to do this, please have a look in our {{Link2CmdRef\|Anker=allowed\|Lang=en\|Label=CommandRef}} or just pass <code>help allowed</code> to the command field.

	As long as there's no allowed device defined, FHEM restricts all interfaces access' to the local network.		As long as there's no allowed device defined, FHEM restricts all interfaces access' to the local network.
Zeile 66:		Zeile 66:

	==Interfaces to the real world==		==Interfaces to the real world==
	{{Randnotiz\|RNTyp=b\|RNText=If you at this point do not have any hardware to be included in your FHEM you may follow our [First steps in FHEM\|first steps in FHEM]] to get an impression how to configure devices in FHEM.}}To get information about what is happening in the real world, you have to somehow connect FHEM with it.		{{Randnotiz\|RNTyp=b\|RNText=If you at this point do not have any hardware to be included in your FHEM you may follow our [[First steps in FHEM\|first steps in FHEM]] to get an impression how to configure devices in FHEM.}}To get information about what is happening in the real world, you have to somehow connect FHEM with it.

	A lot of FHEM installations use one or more USB devices (e.g. CUL, FHZ1x00, TCM, ZWave, ...) directly attached to the FHEM server for this task. To use this type of connection<ref>This also applies when devices are attached using serial interfaces provided at GPIO PINs of single-board computers like the ''Raspberry Pi''.</ref> You need additional pieces of software, especially the Perl module ''serial''<ref>The Perl-''serial''-module can either be installed by issuing the <code>sudo cpan Device::SerialPort</code> command at OS level or by installing precompiled Debian packages (''libdevice-serialport-perl''). Beginning with Mac OS X 10.5 (Leopard) the module is also provided as package. If the perl module is not available for your operating system you may use the ''@directio''-option (see commandref for further information).</ref>. Have a look at the respective part of the commandref for details about the configuration of your USB device(s). The Perl module is not required if the device is connected via ethernet (e.g. HM-LAN or CUNO).		A lot of FHEM installations use one or more USB devices (e.g. CUL, FHZ1x00, TCM, ZWave, ...) directly attached to the FHEM server for this task. To use this type of connection<ref>This also applies when devices are attached using serial interfaces provided at GPIO PINs of single-board computers like the ''Raspberry Pi''.</ref> You need additional pieces of software, especially the Perl module ''serial''<ref>The Perl-''serial''-module can either be installed by issuing the <code>sudo cpan Device::SerialPort</code> command at OS level or by installing precompiled Debian packages (''libdevice-serialport-perl''). Beginning with Mac OS X 10.5 (Leopard) the module is also provided as package. If the perl module is not available for your operating system you may use the ''@directio''-option (see commandref for further information).</ref>. Have a look at the respective part of the commandref for details about the configuration of your USB device(s). The Perl module is not required if the device is connected via ethernet (e.g. HM-LAN or CUNO).
Zeile 75:		Zeile 75:
	Typically you'll have to make additional configuration work also for automatically detected devices by assigning the appropriate values to attributes. You can easily get an overview on the available attributes and to some extend also a set of values for them by just clicking the name of the device shown in the respective room. New devices in most cases can be found in the room ''Unsorted''.		Typically you'll have to make additional configuration work also for automatically detected devices by assigning the appropriate values to attributes. You can easily get an overview on the available attributes and to some extend also a set of values for them by just clicking the name of the device shown in the respective room. New devices in most cases can be found in the room ''Unsorted''.

	Once you have basic definitions of all of your USB devices it's recommended to deactivate the automatic recognition of USB devices by entering >code>attr initialUsbCheck disable 1</code> to the command field.		Once you have basic definitions of all of your USB devices it's recommended to deactivate the automatic recognition of USB devices by entering <code>attr initialUsbCheck disable 1</code> to the command field.

	===Manual Configuration===		===Manual Configuration===